Geophrase Business

Bulk Read

HTTP request

POST https://api.geophrase.com/business/geophrases-bulk-read/

Mind the trailing slash in the URL.

Example request

curl --location 'https://api.geophrase.com/business/geophrases-bulk-read/' \
--header 'X-API-Key: {API key}' \
--header 'Content-Type: application/json' \
--data '[
    "cat-dog-bat", 
    "pah-aki-rer",
    "yau-bao-kil",
    "kid-gus-zel"
]'

Request headers

Header Name	Value
X-API-Key Required	{API key}
Content-Type Required	application/json

Request body

The request body contains JSON array of valid Geophrases.

[
    "cat-dog-bat", 
    "boj-koi-moi",
    ...
]

JSON array in the request body can contain up to 1,000 Geophrases.

Response

Returns status code 200 and a JSON array of Geophrase instances.

Length of response array can be equal to or less than the length of the array submitted in request. Reason is: if any Geophrase included in the request does not exist, it will not be included in the response.

Error response

Returns 4xx HTTP status code and an error response.

Status Code	Description
400	Consider these reasons: Empty array was passed. Array contains more than 1,000 Geophrases. Any Geophrase provided in the request array does match regex ^[a-z]{3}-[a-z]{3}-[a-z]{3}$
403	Consider these reasons: Missing or incorrect X-API-Key header Insufficient wallet balance

Status Code

Description

400

Consider these reasons:

Empty array was passed.
Array contains more than 1,000 Geophrases.
Any Geophrase provided in the request array does match regex
^[a-z]{3}-[a-z]{3}-[a-z]{3}$

403