Dukumiintiga API

Ku billow adeegsiga noo fudud ee isticmaalka API maanta, raac tusaalooyinka si aad u baratid sida loo isticmaalo.




GET Ku hel koodhadhka boostada meel fog

Fududeynta adeegsiga dhamaadka waxaad kuheleysaa liistada lambarrada Boosta ee kujira masaafo fog. Tusaalaha codsigu wuxuu soo celin doonaa liistada lambarrada boosta ee gaarka ah, liis buuxa oo lambarrada boostada ah iyo faahfaahinta lambar kasta oo boosta ah.

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=us

API-keena wuxuu aqbalaa cabbirada masaafada ee kiiloomitir (Hangool) ama maylal.

Si aad ugu beddesho cabbirka kiiloomitir waa inaad ku dhejisaa ms codsigaaga:

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=us

Jawaabtu waxay u ekaan doontaa sidan:

{
   "query":{
      "code": "10005",
      "country": "US",
      "range": "25",
      "measure": ""
   },
   "results":{
       "range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...],
       "range_codes": ["07010", "07020", "07022", "07024", "07026", ...],
       "range_codes_details": [
          {
              "postal_code":"07010",
              "country_code":"US",
              "city":"Cliffside Park",
              "state":"New Jersey",
              "state_code":"NJ",
              "province":"Bergen",
              "province_code":"003"
          },
          {
              "postal_code":"07020",
              "country_code":"US",
              "city":"Edgewater",
              "state":"New Jersey",
              "state_code":"NJ",
              "province":"Bergen",
              "province_code":"003"
          },
          {
              "postal_code":"07022",
              "country_code":"US",
              "city":"Fairview",
              "state":"New Jersey",
              "state_code":"NJ",
              "province":"Bergen",
              "province_code":"003"
          },
          {
              "postal_code":"07024",
              "country_code":"US",
              "city":"Fort Lee",
              "state":"New Jersey",
              "state_code":"NJ",
              "province":"Bergen",
              "province_code":"003"
          },
          {
              "postal_code":"07026",
              "country_code":"US",
              "city":"Garfield",
              "state":"New Jersey",
              "state_code":"NJ",
              "province":"Bergen",
              "province_code":"003"
          },
           ...
       ],
   }
}

GET Hel faahfaahinta furaha boostada

Tusaalaha soo socda ayaa soo celin doona faahfaahinta lambarrada boostada ee ku habboon weydiinta raadinta.

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=us

Jawaabtu waxay u ekaan doontaa sidan:

{
   "query":{
      "code": "10005",
      "country": "us",
      "range": "",
      "measure": ""
   },
   "results":{
       "range_codes_unique": ["10005"],
       "range_codes": ["10005"],
       "range_codes_details": [
          {
              "postal_code":"10005",
              "country_code":"US",
              "city":"New York",
              "state":"New York",
              "state_code":"NY",
              "province":"New York",
              "province_code":"061"
          }
       ],
   }
}

GET Hel xog qaas ah

Waxaad gudbin kartaa params dheeraad ah si aad u hesho kaliya waxa aad u baahan tahay in natiijada, kaliya dar qiimaha fields ee codsigaaga.

GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=us

Jawaabtu waxay u ekaan doontaa sidan:

{
   "query":{
      "code": "10005",
      "country": "US",
      "range": "25",
      "measure": ""
   },
   "results":{
       "range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
   }
}



Ku bilaw adeegsiga API-keena bilaash maanta!

Hel 240 codsiyo bilaash ah maalin kasta

+94 Wadamada la taageero

AD (Andorra)
AR (Argentina)
AS (American Samoa)
AT (Awstaria)
AU (Australia)
AX (Aland Islands)
AZ (Azerbaijan)
BD (Bangladesh)
BE (Belgium)
BG (Bulgaariya)
BM (Bermuda)
BR (Brazil)
Flag of Belarus
BY (Belarus)
CA (Kanada)
CH (Switzerland)
CL (Chile)
CO (Colombia)
CR (Costa Rica)
CY (Cyprus)
CZ (Czech Republic)
Flag of Germany
DE (Germany)
DK (Denmark)
DO (Jamhuuriyadda Dominikan)
DZ (Algeria)
EE (Estonia)
ES (Spain)
FI (Finland)
FM (Micronesia)
FO (Jasiiradaha Faroe)
FR (Faransiiska)
GB (Boqortooyada Ingiriiska)
GF (Faransiiska Guiana)
GG (Guernsey iyo Alderney)
GL (Greenland)
GP (Guadeloupe)
GT (Guatemala)
GU (Guam)
HR (Croatia (Hrvatska))
HU (Hungary)
IE (Ireland)
IM (Man (Isle of))
IN (Hindiya)
IS (Iceland)
IT (Talyaaniga)
JE (Jersey)
JP (Japan)
Flag of South Korea
KR (Koonfurta Kuuriya)
LI (Liechtenstein)
LK (Sirilaanka)
LT (Lithuania)
LU (Luxembourg)
LV (Latvia)
MC (Monaco)
MD (Moldova)
Flag of the Marshall Islands
MH (Jasiiradaha Marshall)
MK (Macedonia)
MP (Northern Mariana Islands)
MQ (Martinique)
MT (Malta)
Flag of Malawi
MW (Malawi)