Standardize address
The Address Standardization API breaks down nonformatted addresses into identifiable components like country, state, city, and more, and corrects any pin code errors.
POSThttps://api.getos1.com/locateone/v1/standardize
Headers
x-api-keystringrequired
This key is used for authentication and billing.
Content-typestringrequired
application/json
Body
bodyobjectrequired
Request body. Contains the address details.
dataobjectrequired
addressstringrequired
The street address which you want to process.
pincodestringoptional
Pincode associated with the provided address.
citystringoptional
City associated with the provided address.
statestringoptional
State associated with the provided address.
Request example
curl --request POST \
--url https://api.getos1.com/locateone/v1/standardize \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: string' \
--data '{
"data": {
"address": ""
}
}'Responses
200400401403429500
200Output of address_standardization API.
successbooleanoptional
True value indicates that the address was succesfully parsed and the response have been returned without any error. A false value would suggst an error in processing the request. The details for the possible reason for any error will be provided via the message key.
Example: true
status_codenumberoptional
Status codes indicate whether a specific API request has been successfully completed. And these codes will also help you track down the reason in case of failure.
Example: 200
messagestringoptional
This field will provide the information regarding the request processed by the address_standardization API. This may help you get an idea about the success or a possible reason for failure.
Example: Request has been processed
request_idstringoptional
A unique id to distinguish between requests.
Example: AX34687667877689
resultobjectoptional
Contains the identifiable address components like country, state, city, locality, and sub locality along with additional information like street, landmark, floor, etc. It also has the identified/corrected pin code.
pincodestringoptional
Pincode identified from the address.
Example: 122003
countrystringoptional
country associated with the provided address.
Example: india
statestringoptional
country associated with the provided address.
Example: haryana
citystringoptional
country associated with the provided address.
Example: gurgaon
localitystringoptional
country associated with the provided address.
Example: sector - 44
sub_localitystringoptional
Most granular locality identified from the address. this can be a sector, road, landmark etc.
Example: delhivery corporate office
entity_informationobjectoptional
Additional information related to the provided address, like floor, street, plot number, wing number, room number, block, phase, etc. This will be in the form of key-value pairs with the available information.
Example: {"plot":"5","sector":"44","door_information":"5"}
pocketstringoptional
pocket identified from the address.
villastringoptional
villa identified from the address.
milestringoptional
mile identified from the address.
floorstringoptional
floor identified from the address.
plotstringoptional
plot identified from the address.
roomstringoptional
room identified from the address.
housestringoptional
house identified from the address.
quarterstringoptional
quarter identified from the address.
doorstringoptional
door identified from the address.
scostringoptional
sco identified from the address.
shopstringoptional
shop identified from the address.
sectorstringoptional
sector identified from the address.
flatstringoptional
flat identified from the address.
cross roadstringoptional
cross road identified from the address.
main roadstringoptional
main road identified from the address.
feet roadstringoptional
feet road identified from the address.
ps roadstringoptional
ps road identified from the address.
crossstringoptional
cross identified from the address.
mainstringoptional
main identified from the address.
cross streetstringoptional
cross street identified from the address.
main streetstringoptional
main street identified from the address.
galistringoptional
gali identified from the address.
hostelstringoptional
hostel identified from the address.
towerstringoptional
tower identified from the address.
blockstringoptional
block identified from the address.
phasestringoptional
phase identified from the address.
streetstringoptional
street identified from the address.
roadstringoptional
road identified from the address.
stagestringoptional
stage identified from the address.
lanestringoptional
lane identified from the address.
buildingstringoptional
building identified from the address.
surveystringoptional
survey identified from the address.
wingstringoptional
wing identified from the address.
avenuestringoptional
avenue identified from the address.
gatestringoptional
gate identified from the address.
wardstringoptional
ward identified from the address.
building_namestringoptional
building_name identified from the address.
societystringoptional
society identified from the address.
unitstringoptional
unit identified from the address.
door_informationstringoptional
door_information identified from the address.
landmark_namearrayoptional
landmark_name identified from the address.
company_namearrayoptional
company_name identified from the address.
400Invalid payload
successbooleanoptional
True value indicates that the address was succesfully parsed and the response have been returned without any error. A false value would suggst an error in processing the request. The details for the possible reson for any error will be provided via the message key.
Example: false
status_codenumberoptional
Status codes indicate whether a specific API request has been successfully completed. And these codes will also help you track down the reason in case of failure.
Example: 400
messagestringoptional
This field will provide the information regarding the request processed by the address_standardization API. This may help you get an idea about the success or a possible reason for failure.
Example: Invalid query parameters provided in input. Caused due to either missing keys or invalid data type for a key.
request_idstringoptional
A unique id to distinguish between requests,
Example: AX34687667877689
resultobjectoptional
Contains the address_standardization result having pincode, locality, geographical coordinates and validity for a given unstructured address.
401Unauthorized
successbooleanoptional
True value indicates that the address was succesfully parsed and the response have been returned without any error. A false value would suggst an error in processing the request. The details for the possible reson for any error will be provided via the message key.
Example: false
status_codenumberoptional
Status codes indicate whether a specific API request has been successfully completed. And these codes will also help you track down the reason in case of failure.
Example: 401
messagestringoptional
This field will provide the information regarding the request processed by the address_standardization API. This may help you get an idea about the success or a possible reason for failure.
Example: Authentication token is invalid.
request_idstringoptional
A unique id to distinguish between requests.
Example: AX34687667877689
resultobjectoptional
Contains the address_standardization result having pincode, locality, geographical coordinates and validity for a given unstructured address.
403Forbidden
successbooleanoptional
True value indicates that the address was succesfully parsed and the response have been returned without any error. A false value would suggst an error in processing the request. The details for the possible reson for any error will be provided via the message key.
Example: false
status_codenumberoptional
Status codes indicate whether a specific API request has been successfully completed. And these codes will also help you track down the reason in case of failure.
Example: 403
messagestringoptional
This field will provide the information regarding the request processed by the address_standardization API. This may help you get an idea about the success or a possible reason for failure.
Example: Authentication token is forbidden to access the API.
request_idstringoptional
A unique id to distinguish between requests.
Example: AX34687667877689
resultobjectoptional
Contains the address_standardization result having pincode, locality, geographical coordinates and validity for a given unstructured address.
429Too many requests
messagestringoptional
This field will provide the information regarding the request processed by the geocoder API. This may help you get an idea about the success or a possible reason for failure.
Example: Too many requests.
500Error message due to internal issue while processing payload or server level issues.
successbooleanoptional
True value indicates that the address was succesfully parsed and the response have been returned without any error. A false value would suggst an error in processing the request. The details for the possible reson for any error will be provided via the message key.
Example: false
status_codenumberoptional
Status codes indicate whether a specific API request has been successfully completed. And these codes will also help you track down the reason in case of failure.
Example: 500
messagestringoptional
This field will provide the information regarding the request processed by the address_standardization API. This may help you get an idea about the success or a possible reason for failure.
Example: Error occured: request data: <payload> with error_details: <error_details>.
request_idstringoptional
The `request_id` will be blank.
resultobjectoptional
Contains the address_standardization result having pincode, locality, geographical coordinates and validity for a given unstructured address.
Response samples
// Output of address_standardization API.
{
"success": true,
"status_code": 200,
"message": "Request has been processed",
"request_id": "AX34687667877689",
"result": {
"pincode": 122003,
"country": "india",
"state": "haryana",
"city": "gurgaon",
"locality": "sector - 44",
"sub_locality": "delhivery corporate office",
"entity_information": {
"pocket": "",
"villa": "",
"mile": "",
"floor": "",
"plot": "",
"room": "",
"house": "",
"quarter": "",
"door": "",
"sco": "",
"shop": "",
"sector": "",
"flat": "",
"cross road": "",
"main road": "",
"feet road": "",
"ps road": "",
"cross": "",
"main": "",
"cross street": "",
"main street": "",
"gali": "",
"hostel": "",
"tower": "",
"block": "",
"phase": "",
"street": "",
"road": "",
"stage": "",
"lane": "",
"building": "",
"survey": "",
"wing": "",
"avenue": "",
"gate": "",
"ward": "",
"building_name": "",
"society": "",
"unit": "",
"door_information": "",
"landmark_name": [
""
],
"company_name": [
""
]
}
}
}