Getting started
Introduction
The S2Coder Address API gives you programmatic access to Indian address data: autocomplete, full-text search, validation, PIN code lookup, and forward and reverse geocoding. It also backs a dashboard where you can import, manage and export your own address database.
Base URL
Every endpoint lives under a version prefix, so a future v2 can be introduced without breaking your integration.
https://address.s2coder.com/api/v1Quick start
Create an account, copy the API key you are shown once, and make your first call.
curl "https://address.s2coder.com/api/v1/pincode/226010" \
-H "X-API-Key: YOUR_API_KEY"Endpoints at a glance
| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1/address/autocomplete | Ranked type-ahead suggestions |
| GET | /api/v1/address/search | Filtered address search |
| GET | /api/v1/address/by-mobile/{mobile} | Every address for one customer's mobile |
| GET | /api/v1/checkout/address/{mobile} | Magic checkout: last-used address for a shopper |
| POST | /api/v1/checkout/address | Magic checkout: save the confirmed address |
| POST | /api/v1/address/validate | Validate and correct an address |
| GET | /api/v1/address/{id} | Fetch a single address |
| GET | /api/v1/pincode/{pincode} | PIN code lookup |
| GET | /api/v1/geocode | Address to coordinates |
| GET | /api/v1/reverse-geocode | Coordinates to nearby addresses |
| GET | /api/v1/status | Key status and remaining quota |
Response format
Successful responses carry "success": true. Collection endpoints wrap
results in data with a meta block; the PIN code and
validation endpoints return their fields at the top level, since there is only
ever one result.
{
"success": true,
"data": [ ... ],
"meta": { "count": 5, "query": "gomti nagar" }
}Errors always use the same shape, described in full on the Errors page.
Data sources and licensing
Reference data — states, districts, cities, localities and PIN codes — comes from openly licensed government datasets and properly licensed commercial providers. We do not scrape third-party address databases, and the platform is built so that a licensed feed can be swapped in without touching application code.
Address data you import belongs to you. It is stored against your account, visible only to your API keys, and never mixed into the shared reference dataset unless an administrator explicitly promotes it. Your original row text is preserved verbatim alongside the normalised version, so nothing you upload is ever destroyed.
Conventions
- All timestamps are ISO 8601 in UTC unless stated otherwise.
- PIN codes are six-digit strings starting with 1–8, returned as strings so leading context is never lost.
- Coordinates use WGS 84 decimal degrees, rounded to seven places.
- Every response carries an
X-Request-Idheader — quote it when reporting an issue.