Get Place

Use this method to get the details of previously created custom places using its NextBillion ID.

get/multigeocode/place/{docId}

Request

Base URL
https://api.nextbillion.io
Auth
API key in query parameter key
TypeScript
https://skmtc.dev/nextbillion-ai/apis/one-spec-service/docs/multigeocode/place/:docId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

docIdstring required

Unique NextBillion ID of the location to be looked up.

Query parameters

keystring 32 character alphanumeric string required

Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Response

docIdstring

The unique NextBillion ID for the result item.

scoreinteger

It returns the system calculated weighted score of the place. It depends on how ‘richly’ the place was defined at the time of creation. In order to modify the score, use “Update Place” method and update information for parameters which are not set currently. As an alternative, you can directly update the score to a custom value.

Changes

No recorded changes to this operation across all 15 revisions of this API.