MedPlus Mart PIN Code Localities
medplus.pincode.check
Resolve an Indian PIN code or area name to the MedPlus Mart localities the storefront serves, with each place id.
At a glance
- Endpoint ID
medplus.pincode.check- Price
- 1 credit per call; failed calls are free
- Runs for up to
- 30 seconds
Request
Send the endpoint ID as capability and its fields as input. Set UPSCRAPE_API_KEY to your key first.
curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "capability": "medplus.pincode.check", "input": { "pincode": "500018" }}'
import jsonimport osimport requestspayload = json.loads(r'''{ "capability": "medplus.pincode.check", "input": { "pincode": "500018" }}''')response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload,)response.raise_for_status()print(json.dumps(response.json(), indent=2))
const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": `Bearer ${process.env.UPSCRAPE_API_KEY}`, "Content-Type": "application/json", "Prefer": "wait=30", }, body: JSON.stringify({ "capability": "medplus.pincode.check", "input": { "pincode": "500018" }}),});if (!response.ok) { throw new Error(`Upscrape request failed: ${response.status}`);}console.log(JSON.stringify(await response.json(), null, 2));
Input
| Field | Type | Required | What it does | Example |
|---|---|---|---|---|
pincode |
string | one of | Six-digit Indian PIN code. | 500018 |
query |
string | one of | Area or locality name to look up instead of a PIN code. |
Response
A finished call answers with HTTP 200; the data is in results[0].data, and billing.credits_charged is what it cost. A call still running after the wait answers 202: see jobs and results.
This is results[0].data from a real run:
{ "query": "500018", "localities": [ { "location": "500018, New Shastry Nagar, Sultan Nagar, Erragadda, Hyderabad, Telangana, India", "place_id": "ChIJkVkDph2RyzsR8-wfgrB68Xk" }, { "location": "Hyderabad, Telangana 500018, India", "pincode": "500018", "place_id": "ChIJjR9aNQORyzsR2aUWzfGjnxA" } ]}
Fields
| Field | Type | Example |
|---|---|---|
localities[].location |
string | 500018, New Shastry Nagar, Sultan Nagar, Erragadda, Hyderabad, … |
localities[].place_id |
string | ChIJkVkDph2RyzsR8-wfgrB68Xk |
localities |
array | 3 records |
query |
string | 500018 |
If a call fails
A failed call costs nothing. The response carries an error.code you can branch on; Errors and retries lists every code and which ones to retry.
Other MedPlus Mart endpoints
Something missing or unclear? Ask the team that builds the MedPlus Mart endpoints.