POST/Address_code

Request URL

1
curl -X POST "https://rest-api.argoskyc.com/v3/address_code"
2
-H "x-api-key: {yourAPIKey}" \
Copied!

Input Data

* means required parameters.
Parameter
Format
Description
*address
string
You can search by entering one of the following:
  • Address
  • Global code
  • Compound code
  • Latitude and longitude (Separate by comma, ex. 38.897,77.036)
language
string
Language selection for the returned value. (ISO 3166-2 Code) (ex. "en")

Sample Request 1

1
var request = require('request');
2
var options = {
3
'method': 'POST',
4
'url': 'https://rest-api.argoskyc.com/v3/address_code',
5
'headers': {
6
'x-api-key': 'YOUR_API_KEY',
7
'Content-Type': 'application/x-www-form-urlencoded'
8
},
9
form: {
10
'address': '20 W 34th St, New York, NY 10001'
11
}
12
};
13
request(options, function (error, response) {
14
if (error) throw new Error(error);
15
console.log(response.body);
16
});
Copied!

Sample Request 2

1
curl --location --request POST 'https://rest-api.argoskyc.com/v3/address_code' \
2
--header 'x-api-key: YOUR_API_KEY' \
3
--header 'Content-Type: application/x-www-form-urlencoded' \
4
--data-urlencode 'language=en' \
5
--data-urlencode 'address=20 W 34th St, New York, NY 10118, USA'
Copied!

Output Data

Response
Description
formatted_address
Transformed address from detailed code
compound_code
Detailed code, city and country from the address (ex. VXX7+39 Washington, DC, USA)
global_code
Detailed code from the address (ex. 87C4VXX7+39)

Sample Response

1
{
2
"formatted_address": "20 W 34th St, New York, NY 10118, USA",
3
"compound_code": "P2X7+GP New York, NY",
4
"global_code": "87G8P2X7+GP"
5
}
Copied!
Copy link