GET Nearby API · Mappls Developers

Legacy contract evidence

This operation was normalized from a MapmyIndia-generation specification. Validate its current Mappls host, path, package entitlement, authentication generation, and commercial availability before production use.

Request target

Call the operation

GEThttps://atlas.mapmyindia.com/api/places/nearby/json?keywords=FODCOF&refLocation=28.612964%2C77.229463

Base URLhttps://atlas.mapmyindia.com

Authenticationoauth2 bearer

Journey rolerequest response

Content typesNo request body

Path, query, and headers

Parameters

NameLocationTypeDescriptionExample

keywordsrequired

querystring

Enter the query on which the search has to be done. Operators in Keywords parameter To send multiple keywords in a request, we’ve defined a couple of operators that can help the developers wrap their applications around this functionality. Below are the operators: The “ ; ” Operator: This operator is an “or” operator. Defining multiple keywords separated with a “ ; ” would provide results that satisfies either of the keywords. The “ $ ” Operator: This operator is a “and” operator. Defining multiple keywords separated with a “ $ ” would provide results that satisfy all the provided keywords. (default). To use these operators, simple just send in the keywords parameter like below: &keywords=co

FODCOF

refLocationrequired

querystring

Provides the location around which the search will be performed. e.g. refLocation=28.454,77.435. The refLocation parameter can also accept eLoc as reference location. This configuration is not active by default. Please contact MapmyIndia API support for further details. Example: refLocation=17ZUL7

28.612964,77.229463

page

queryinteger

provides number of the page to provide results from.

1

region

querystring

it takes in the country code. LKA, IND, BTN, BGD, NPL for Sri-Lanka, India, Bhutan, Bangladesh, Nepal respectively. Default is India (IND)

IND

radius

queryinteger

Provides the range of distance to search over (default 1000, min, 500, max, 10000)

10000

bounds

querystring

(x1,y1;x2,y2) Allows the developer to send in map bounds to provide a nearby search of the geobounds. where x1,y1 are the lat lng of the bound. The bounds are set from topLeft to bottomRight (North-West to South-East).

28.639256,77.211133;28.625214,77.237483

filter

querystring

It uses key:value pair(s) to fine tune discovery of places by filtering the results. e.g. categoryCode:FODCOF valid IDs for key value pairs are: categoryCode: can take in category codes as input

categoryCode:FODCOF

sortBy

querystring

Provides configured sorting operations for the client on cloud. Below are the available sorts: dist:asc & dist:desc - will sort data in order of distance from the passed location (default). name:asc & name:desc - will sort the data on alphabetically bases. imp - will sort data in order of decreasing prominence of the place.

dist:asc

searchBy

querystring

provides configurable search operations for the client on cloud. Below are the available sorts: dist(default) - will sort data in order of distance from the passed location (default). imp - will search data in order of prominence of the place.

dist

pod

querystring

It takes in the place type code which helps in restricting the results to certain chosen type. Access to this parameter is controlled from the backend. This parameter, if provided will override any values provided in keywords request param. Below mentioned are the available values for pod: SLC - Sublocality LC - Locality CITY - City STATE - State

LC

Interactive, local, and credential-safe

Build your request in eight languages

Change source-backed examples once, validate required inputs, and copy the synchronized cURL, JavaScript, Python, Java, C#, Go, PHP, or Ruby request. Credentials remain environment references, and this page never sends a provider request.

Local request composerCode stays local · fixtures are explicit

GETRequest inputs

10 editable · 0 protected

keywordsrequiredqueryEnter the query on which the search has to be done. Operators in Keywords parameter To send multiple keywords in a request, we’ve defined a couple of operators that can help the developers wrap their applications around this functionality. Below are the operators: The “ ; ” Operator: This operator is an “or” operator. Defining multiple keywords separated with a “ ; ” would provide results that satisfies either of the keywords. The “ $ ” Operator: This operator is a “and” operator. Defining multiple keywords separated with a “ $ ” would provide results that satisfy all the provided keywords. (default). To use these operators, simple just send in the keywords parameter like below: &keywords=corefLocationrequiredqueryProvides the location around which the search will be performed. e.g. refLocation=28.454,77.435. The refLocation parameter can also accept eLoc as reference location. This configuration is not active by default. Please contact MapmyIndia API support for further details. Example: refLocation=17ZUL7pagequeryprovides number of the page to provide results from.regionqueryit takes in the country code. LKA, IND, BTN, BGD, NPL for Sri-Lanka, India, Bhutan, Bangladesh, Nepal respectively. Default is India (IND)radiusqueryProvides the range of distance to search over (default 1000, min, 500, max, 10000)boundsquery(x1,y1;x2,y2) Allows the developer to send in map bounds to provide a nearby search of the geobounds. where x1,y1 are the lat lng of the bound. The bounds are set from topLeft to bottomRight (North-West to South-East).filterqueryIt uses key:value pair(s) to fine tune discovery of places by filtering the results. e.g. categoryCode:FODCOF valid IDs for key value pairs are: categoryCode: can take in category codes as inputsortByqueryProvides configured sorting operations for the client on cloud. Below are the available sorts: dist:asc & dist:desc - will sort data in order of distance from the passed location (default). name:asc & name:desc - will sort the data on alphabetically bases. imp - will sort data in order of decreasing prominence of the place.searchByqueryprovides configurable search operations for the client on cloud. Below are the available sorts: dist(default) - will sort data in order of distance from the passed location (default). imp - will search data in order of prominence of the place.podqueryIt takes in the place type code which helps in restricting the results to certain chosen type. Access to this parameter is controlled from the backend. This parameter, if provided will override any values provided in keywords request param. Below mentioned are the available values for pod: SLC - Sublocality LC - Locality CITY - City STATE - State

Generated in eight languages

Environment-backed credentials

GET

https://atlas.mapmyindia.com/api/places/nearby/json?keywords=FODCOF&refLocation=28.612964%2C77.229463&page=1&region=IND&radius=10000&bounds=28.639256%2C77.211133%3B28.625214%2C77.237483&filter=categoryCode%3AFODCOF&sortBy=dist%3Aasc&searchBy=dist&pod=LC

Credential-free sandboxExecute this contract without a provider call

How fixtures work

Generated from your inputs

curl --request GET \
  --url 'https://atlas.mapmyindia.com/api/places/nearby/json?keywords=FODCOF&refLocation=28.612964%2C77.229463&page=1&region=IND&radius=10000&bounds=28.639256%2C77.211133%3B28.625214%2C77.237483&filter=categoryCode%3AFODCOF&sortBy=dist%3Aasc&searchBy=dist&pod=LC' \
  --header "Accept: application/json" \
  --header "Authorization: Bearer ${MAPPLS_ACCESS_TOKEN}"

Credential-safe by constructionSet MAPPLS_ACCESS_TOKEN only in your trusted runtime. Code generation stays local. Sandbox execution sends only bounded fixture inputs to this developer platform and never reads a credential or calls Mappls.

Five language quickstarts

Send a production-shaped request

Examples use environment-backed access tokens, explicit timeouts where supported, status checks, and JSON bodies derived from the source schema. Replace sample identifiers and coordinates with values from your application.

GET /api/places/nearby/json

curl --request GET \
  --url 'https://atlas.mapmyindia.com/api/places/nearby/json?keywords=FODCOF&refLocation=28.612964%2C77.229463' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Success and failure behavior

Responses

200

204

Not found

400

Bad request

401

API access denied

403

Forbidden

500

Something went wrong

503

Internal server error

200 response fields

FieldTypeDescriptionExample

suggestedLocationsrequired

array<object>

No field description in the source contract.

28.612964,77.229463

suggestedLocations[].addressTokensrequired

object

No field description in the source contract.

YOUR_ACCESS_TOKEN

suggestedLocations[].addressTokens.houseNumber

string

House Number of the POI.

237

suggestedLocations[].addressTokens.houseName

string

House Name of the POI.

MMI Building

suggestedLocations[].addressTokens.poi

string

Name of the POI.

MapmyIndia Head Office

suggestedLocations[].addressTokens.street

string

Name of the street.

—

suggestedLocations[].addressTokens.subSubLocality

string

Name of the subsublocality.

—

suggestedLocations[].addressTokens.subLocality

string

Name of the sublocality.

—

suggestedLocations[].addressTokens.locality

string

Name of the locality.

Okhla industrial phase 3

suggestedLocations[].addressTokens.village

string

Name of the village.

Okhla Vilage

suggestedLocations[].addressTokens.subDistrict

string

Name of the subDistrict.

—

suggestedLocations[].addressTokens.districtrequired

string

Name of the District.

South Delhi

suggestedLocations[].addressTokens.cityrequired

string

Name of the city.

New Delhi

suggestedLocations[].addressTokens.staterequired

string

Name of the STATE.

1700000000000

suggestedLocations[].addressTokens.pincode

integer

PINcode of the location.

110010

suggestedLocations[].distancerequired

string

provides the distance from the provided location bias in meters

64

suggestedLocations[].elocrequired

string

Place Id of the location 6-char alphanumeric

MMI000

suggestedLocations[].emailrequired

string

Email for contact

xyz@email.com

suggestedLocations[].entryLatituderequired

number

latitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.

28.612964

suggestedLocations[].entryLongituderequired

number

longitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.

77.229463

suggestedLocations[].hourOfOperationrequired

string

The hours of operation of the POI in a day.

poi

suggestedLocations[].keywordsrequired

array<object>

The keywords/category codes associated with the given result.

example

suggestedLocations[].landlineNorequired

number

phone no for contact

911133107634

suggestedLocations[].latituderequired

number

Latitude of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.

28.612964

suggestedLocations[].longituderequired

number

longitude of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.

77.229463

suggestedLocations[].mobileNorequired

number

Phone number for contact

919999827144

suggestedLocations[].orderIndexrequired

integer

the order where this result should be placed

1

suggestedLocations[].placeAddressrequired

string

Address of the location

G-72, 1st Floor, Outer Circle, Connaught Place, New Delhi, Delhi, 110001

suggestedLocations[].placeNamerequired

string

Name of the location

Lord of The Drinks

suggestedLocations[].typerequired

string

Type of location POI or Country or City

poi

pageInforequired

object

No field description in the source contract.

example

pageInfo.pageCountrequired

integer

The number of pages with results.

1

pageInfo.totalHitsrequired

integer

Total number of places in the results.

2730

pageInfo.totalPagesrequired

integer

Total number of pages as per page size and no of results.

2730

pageInfo.pageSizerequired

integer

The number of results per page.

2730

Response example

{
  "suggestedLocations": [
    {
      "addressTokens": {
        "district": "South Delhi",
        "city": "New Delhi",
        "state": "Delhi"
      },
      "distance": 64,
      "eloc": "CHZZ3S",
      "email": "xyz@email.com",
      "entryLatitude": "RESTRICTED",
      "entryLongitude": "RESTRICTED",
      "hourOfOperation": "poi",
      "keywords": [
        "FINATM"
      ],
      "landlineNo": 911133107634,
      "latitude": "RESTRICTED",
      "longitude": "RESTRICTED",
      "mobileNo": 919999827144,
      "orderIndex": 1,
      "placeAddress": "G-72, 1st Floor, Outer Circle, Connaught Place, New Delhi, Delhi, 110001",
      "placeName": "Lord of The Drinks",
      "type": "poi"
    }
  ],
  "pageInfo": {
    "pageCount": 1,
    "totalHits": 2730,
    "totalPages": 2730,
    "pageSize": 2730
  }
}

stateless integration

Operate it safely

request-response

This operation is evaluated independently from the request. Cache and retry according to its documented semantics.

Keep credentials and raw tokens out of source, client bundles, prompts, and logs.Record the operation ID, status, latency, retry count, and source contract version in traces.Classify 4xx responses before retrying; back off and add jitter for retryable 5xx or transport failures.Cache only when request inputs, authorization scope, and freshness requirements permit it.

Auditable source

Contract provenance

Source file: contenthub/dochub/mapmyindia-rest-api/docs/custom/nearby.yml
SHA-256: 4819a31c609c119f03f1db37e90ffc674ff1de4ae1a6336ec5872757bd5d0551
Normalization: Fields are parsed from OpenAPI. Operational guidance and language samples are generated and labeled separately.
Source record: Open repository audit