फ़ॉरवर्ड जियोकोडिंग
टेक्स्ट को निर्देशांकों में बदलें। किसी भी भाषा में पूरे पते, अधूरे पते, पिन कोड, जगहों के नाम और रुचि के स्थान स्वीकार करता है।
पैरामीटर
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
qज़रूरी* | string | जियोकोड करने के लिए मुक्त रूप का टेक्स्ट। अधिकतम 256 अक्षर। |
street, city, state, postcode, country | string | *q का संरचित विकल्प। तब उपयोग करें जब पता पहले से फ़ील्ड में हो। अगर q नहीं है तो कम से कम एक ज़रूरी है। यहाँ country एक ISO 3166-1 alpha-2 कोड है। |
place_id | string | *ऑटोकम्प्लीट से मिला एक place_id। पूरे कंपोनेंट और सीमाओं के साथ वही एक जगह लौटाता है। q को ओवरराइड करता है। |
limitवैकल्पिक | integer | अधिकतम परिणाम, 1 से 10। डिफ़ॉल्ट 5। |
countriesवैकल्पिक | string | कॉमा से अलग किए गए ISO 3166-1 alpha-2 कोड। केवल इन देशों के परिणाम लौटाए जाते हैं। उदाहरण: gb,ie। |
boundsवैकल्पिक | string | दशमलव डिग्री में south,west,north,east। बॉक्स के अंदर के परिणाम पहले आते हैं। बॉक्स के बाहर के परिणाम हटाने के लिए strict=1 जोड़ें। |
proximityवैकल्पिक | string | lat,lon। इस बिंदु के पास के परिणाम पहले आते हैं। |
langवैकल्पिक | string | रिस्पॉन्स में नामों के लिए ISO 639-1 कोड। डिफ़ॉल्ट en। |
keyवैकल्पिक | string | API कुंजी, अगर X-API-Key हेडर के रूप में नहीं भेजी गई। |
उदाहरण
$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/forward?q=Dam+1,+Amsterdam&countries=nl&limit=1"const url = new URL("https://api.mygeocode.com/v1/forward");
url.searchParams.set("q", "Dam 1, Amsterdam");
url.searchParams.set("countries", "nl");
url.searchParams.set("limit", "1");
const data = await (await fetch(url, { headers: { "X-API-Key": "YOUR_KEY" } })).json();
console.log(data.results[0]);import requests
r = requests.get("https://api.mygeocode.com/v1/forward",
params={"q": "Dam 1, Amsterdam", "countries": "nl", "limit": 1}, headers={"X-API-Key": "YOUR_KEY"}, timeout=10)
print(r.json()["results"][0]){
"status": "ok",
"query": "Dam 1, Amsterdam",
"results": [
{
"formatted": "Dam 1, 1012 JS Amsterdam, Netherlands",
"lat": 52.373119,
"lon": 4.893604,
"type": "address",
"precision": "house",
"confidence": 0.98,
"place_id": "nl.addr.c21d40e8",
"components": {
"house_number": "1",
"road": "Dam",
"neighbourhood": "Centrum",
"city": "Amsterdam",
"state": "North Holland",
"state_code": "NH",
"postcode": "1012 JS",
"country": "Netherlands",
"country_code": "nl"
},
"bounds": { "north": 52.373519, "south": 52.372719, "east": 4.894204, "west": 4.893004 }
}
]
}रिस्पॉन्स फ़ील्ड
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
query | string | वह टेक्स्ट जिसे हमने ट्रिम करने के बाद समझा। |
results | array | मिलान, सबसे अच्छा पहले। कुछ भी मेल न खाने पर खाली। |
results[].formatted | string | देश के पारंपरिक फ़ॉर्मैट में पूरा पता। |
results[].lat, lon | number | WGS 84 दशमलव डिग्री। |
results[].type | string | address, street, postcode, city, region, country, poi. |
results[].precision | string | house, street, postcode, admin। बिंदु क्या दर्शाता है। कवरेज देखें। |
results[].confidence | number | 0 से 1। परिणाम क्वेरी से कितना मेल खाता है। 0.5 से कम का मतलब है कि हमने अनुमान लगाया। |
results[].place_id | string | इस जगह का स्थिर पहचानकर्ता। |
results[].components | object | पते के हिस्से। नीचे देखें। |
results[].bounds | object | मिलान वाले फ़ीचर के north, south, east, west। |
कंपोनेंट कुंजियाँ
केवल लागू होने वाली कुंजियाँ मौजूद होती हैं। हर देश में यही कुंजियाँ इस्तेमाल होती हैं।
| कुंजी | अर्थ |
|---|---|
name | रुचि के स्थान या इमारत का नाम, जब मिलान ऐसा हो। |
house_number | अक्षरों और रेंज समेत: 221B, 12-14। |
road | सड़क का नाम उसके प्रकार के साथ: Baker Street, Avenue Anatole France। |
neighbourhood, suburb | शहर के भीतर के इलाके, जहाँ देश इनका उपयोग करता है। |
city | शहर, कस्बा या गाँव। |
county | काउंटी या ज़िला। |
state, state_code | राज्य, प्रांत या क्षेत्र, और जहाँ मौजूद हो वहाँ उसका ISO 3166-2 प्रत्यय। |
postcode | पिन कोड, उसी फ़ॉर्मैट में जिसमें डाक प्राधिकरण उसे लिखता है। |
country, country_code | देश का नाम और छोटे अक्षरों में ISO 3166-1 alpha-2 कोड। |
टिप्पणियाँ
- परिणाम कॉन्फ़िडेंस, सटीकता और निकटता के मेल से क्रमबद्ध होते हैं। जब तक आप कोई चयन सूची नहीं दिखा रहे, पहला परिणाम ही इस्तेमाल करें।
- जब किसी ज्ञात सड़क पर मकान नंबर नहीं मिलता, तो परिणाम में
type: streetऔरprecision: streetहोता है, और जहाँ डेटा अनुमति देता है वहाँ नंबर इंटरपोलेट किया जाता है। अगर यह आपके लिए मायने रखता है तोprecisionजाँचें। - सिर्फ़ पिन कोड भी
qके रूप में ठीक हैं। केवल पिन कोड वाले काम के लिए पिन कोड एंडपॉइंट तेज़ है और डाक प्राधिकरण का जगह का नाम लौटाता है। - किसी जगह के लिए उस लिपि से अलग लिपि में क्वेरी (मान लीजिए किसी जापानी पते के लिए सिरिलिक) काम करती है, लेकिन रिस्पॉन्स की लिपि
langतय करता है।
यही लुकअप दूसरे प्रदाताओं के फ़ॉर्मैट में
अगर आपके पास इनमें से किसी प्रदाता के लिए पहले से लिखा कोड है, तो उसे रखें: ड्रॉप-इन होस्ट वही पाथ और पैरामीटर स्वीकार करता है और उस प्रदाता के रिस्पॉन्स ढाँचे में जवाब देता है, जिसके पीछे यही एंडपॉइंट होता है। ड्रॉप-इन कैसे काम करते हैं देखें।
| प्रदाता | होस्ट | पाथ |
|---|---|---|
| Google Maps प्लैटफ़ॉर्म | gapi.mygeocode.com | /maps/api/geocode/json?address=... |
| Bing Maps REST सेवाएँ | bing.mygeocode.com | /REST/v1/Locations?q=.../REST/v1/Locations?countryRegion=...&locality=...&addressLine=... |
| HERE Geocoding और Search | here.mygeocode.com | /v1/geocode?q=.../v1/geocode?qq=street=...;city=... |
| Mapbox Geocoding | mapbox.mygeocode.com | /geocoding/v5/mapbox.places/{query}.json/search/geocode/v6/forward?q=... |
| Geocode.Farm | farm.mygeocode.com | /forward/?addr=.../v3/json/forward/?addr=... |
| OpenStreetMap Nominatim | osm.mygeocode.com | /search?q=...&format=json/search?street=...&city=...&country=...&format=json |
| OpenCage | opencage.mygeocode.com | /geocode/v1/json?q=.../geocode/v1/geojson?q=... |
| LocationIQ | locationiq.mygeocode.com | /v1/search?q=...&format=json |
| Geoapify | geoapify.mygeocode.com | /v1/geocode/search?text=... |
| TomTom Search | tomtom.mygeocode.com | /search/2/geocode/{query}.json/search/2/structuredGeocode.json?countryCode=...&streetName=... |
| MapQuest Geocoding | mapquest.mygeocode.com | /geocoding/v1/address?location=.../geocoding/v1/batch?location=...&location=... |
| Geocodio | geocodio.mygeocode.com | /v1.7/geocode?q=.../v1.7/geocode (POST, JSON array) |
| PositionStack | positionstack.mygeocode.com | /v1/forward?query=... |
बल्क लुकअप
उसी पाथ पर queries के साथ एक JSON बॉडी POST करें, जो अधिकतम 100 पतों का array हो, और जवाब में एक results array आता है जिसमें भेजे गए क्रम में हर क्वेरी की एक प्रविष्टि होती है। हर प्रविष्टि एक अनुरोध के रूप में गिनी जाती है, और बचे हुए कोटा से बड़ा बैच पूरा का पूरा अस्वीकार कर दिया जाता है।
$ curl -X POST "https://api.mygeocode.com/v1/forward" -H "Content-Type: application/json" -d '{"queries": ["Brandenburg Gate, Berlin", "Bahnhofstrasse 1, Zurich"]}'एरर
400 invalid_request जब न q, न कोई संरचित फ़ील्ड और न place_id मौजूद हो, जब limit 1 से 10 के बाहर हो, या जब bounds या proximity गलत रूप में हो। बाकी के लिए त्रुटियाँ देखें।