States

Get List of States

get
โ€‹

โ€Žhttps://<domain>/<api prefix>/<version>/get/states/<country_short_code>/
This API endpoint returns all states list based on the country short code specified in the url. Replace in the url to country short code and it must be a valide (country code) string value.
Request
Response
Request
Headers
apikey
required
string
apikey
Authorization
required
string
Bearer access token
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
โ€‹
Body:
{
"status_code": 200,
"errors": {},
"data": {
"countries": [
{
"id": <state id>,
"code": <state short name code>,
"name": <state name>
}
]
}
}

Sample code

Node

var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/get/states/<country_short_code>/',
'headers': {
'apikey': '<apikey>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});

PHP

<?php
โ€‹
$curl = curl_init();
โ€‹
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/get/states/<country_short_code>/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>"
),
));
โ€‹
$response = curl_exec($curl);
โ€‹
curl_close($curl);
echo $response;