My Geocode

الاستعلام عن الرمز البريدي

تُدخل رمزًا بريديًا، فتحصل على المكان الذي ينتمي إليه. يغطي 160 دولة.

GEThttps://api.mygeocode.com/v1/postcode

المعاملات

المعاملالنوعالوصف
codeمطلوبسلسلة نصيةالرمز البريدي. تُوحَّد المسافات والشرطات وحالة الأحرف.
countryاختياريسلسلة نصيةرمز ISO 3166-1 alpha-2. يوصى به بشدة، فالرموز البريدية ليست فريدة بين الدول. دونه تُعاد النتائج من كل دولة مطابقة، الأكثر سكانًا أولًا.
langاختياريسلسلة نصيةرمز ISO 639-1 لأسماء الأماكن والمناطق. القيمة الافتراضية en.
keyاختياريسلسلة نصيةمفتاح API، إذا لم يُرسل في ترويسة.

مثال

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/postcode?code=75008&country=fr"
const url = new URL("https://api.mygeocode.com/v1/postcode");
url.searchParams.set("code", "75008");
url.searchParams.set("country", "fr");

const { results } = await (await fetch(url, { headers: { "X-API-Key": "YOUR_KEY" } })).json();
console.log(results[0].place, results[0].lat, results[0].lon);
import requests

r = requests.get("https://api.mygeocode.com/v1/postcode", params={"code": "75008", "country": "fr"}, headers={"X-API-Key": "YOUR_KEY"}, timeout=5)
first = r.json()["results"][0]
print(first["place"], first["lat"], first["lon"])
الاستجابة
{
  "status": "ok",
  "postcode": "75008",
  "country_code": "FR",
  "results": [
    {
      "postcode": "75008",
      "place": "Paris 8e Arrondissement",
      "region": "Ile-de-France",
      "region_code": "IDF",
      "country": "France",
      "country_code": "FR",
      "lat": 48.8727,
      "lon": 2.3125
    }
  ]
}

حقول الاستجابة

الحقلالنوعالوصف
postcodeسلسلة نصيةالرمز بعد التوحيد القياسي.
country_codeسلسلة نصية أو nullمرشح الدولة المطبّق، إن وُجد.
resultsمصفوفةالأماكن التي يغطيها الرمز. عادةً مكان واحد، وعدة أماكن للرموز الريفية التي تمتد عبر عدة قرى. فارغة إذا كان الرمز غير معروف.
results[].placeسلسلة نصيةاسم المنطقة كما تستخدمه هيئة البريد.
results[].region, region_codeسلسلة نصيةالتقسيم الإداري من المستوى الأول ولاحقة ISO 3166-2 الخاصة به.
results[].lat, lonرقمنقطة هيئة البريد حيث تكون منشورة، وإلا فمركز العناوين الواقعة ضمن الرمز.

ملاحظات

الأخطاء

400 invalid_request عندما يكون code فارغًا أو أطول من 16 حرف، أو لا يكون country رمز alpha-2 صالحًا.