Request

Call https://api.parseapi.com using the method and path shown in the endpoint reference. Most lookups use GET. Endpoints such as Bank and Elevation also accept POST with a JSON body.

Start with a complete lookup. This request parses a name, sends your key in a header, and selects API 2.0.0.

curl "https://api.parseapi.com/name/Ada%20Lovelace" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Parse-Version: 2.0.0"

Run on your server with a secret key. Calling from a browser or app?

What goes where

Method: GET sends lookup input in the URL. POST sends the documented input in the body. A POST lookup still returns a lookup result. Follow the endpoint's supported methods.
Path: /name/{name} is a template. Replace the braces and their contents with your value. In the example, Ada%20Lovelace is the encoded value of Ada Lovelace.
Query: Named inputs and options follow ?, with & between them. For example, /city?q=Paris&country=FR&limit=5 searches a name prefix, narrows the country, and returns up to five matches.
Headers: Send your key as X-API-Key or Authorization: Bearer. Use Parse-Version to select the response contract. Send Content-Type: application/json for a JSON body. Authentication and API keys explain server, browser, and app access.
Body: Use the endpoint's documented JSON fields and types. For POST /bank, the IBAN and lookup options belong in the body. Keep account details out of query strings.

Search and filter with query parameters

Searches can use a bare product path with named query inputs. City accepts a name prefix in q, or coordinates in lat and lon. Use one documented input mode at a time. City search describes its filters and result limit.

curl "https://api.parseapi.com/city?q=Paris&country=FR&limit=5" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Parse-Version: 2.0.0"

Run on your server with a secret key. Calling from a browser or app?

Collection size and pagination vary by endpoint. A limit is a maximum, so a response can contain fewer results. Some searches return a cursor for the next page. Follow that endpoint's pagination rules rather than adding a generic page or offset.

Send a JSON body with POST

For Bank, send the original IBAN as a JSON string. The example is a public test value. Bank documents its body fields and validation results. Elevation accepts coordinate lists or a sampled path in a JSON body.

curl "https://api.parseapi.com/bank" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Parse-Version: 2.0.0" \
  -H "Content-Type: application/json" \
  --data-raw '{"iban":"DE89370400440532013000"}'

Run on your server with a secret key. Calling from a browser or app?

JSON strings retain the original text. Do not URL-encode a JSON value. Use JSON booleans such as "deep": true, not the string "true". Keep identifiers and codes as strings where the reference specifies a string, including leading zeros.

Encode inputs and check endpoint rules

Encode input values containing spaces or reserved characters. For a name in the path, use encodeURIComponent(value). Pass raw query values to URLSearchParams. It encodes them for you so characters such as +, &, and # stay part of the value. Do not encode the whole URL or encode a value twice.

const namePath = '/name/' + encodeURIComponent('Ada Lovelace');
const query = new URLSearchParams({ q: 'Paris', country: 'FR', limit: '5' });
const searchPath = '/city?' + query.toString();

Open the endpoint's Parameters section before building a request. It shows required inputs, types, defaults, limits, and allowed values. Omit an optional input to use its documented default. An empty string is a supplied value, and some endpoints reject it. Use each named option once unless the reference allows otherwise.

Country context, language, dates, radius, pagination, and Deep vary by endpoint. An option accepted by one API is not automatically accepted by another. Check the endpoint's supported countries and coverage too. Browse the API references or use the OpenAPI specification for machine-readable definitions.

Examples here pin Parse-Version: 2.0.0. Without that header, keyed requests use the team's saved version. The keyless lookup on the Quickstart page uses the self-lookup default. Read API versions before choosing a contract for your application.

Add ?pretty=true for formatted JSON. Formatting does not change the response fields.

Check the HTTP status and the response fields before using a result. For failures, follow Errors and Retries. Requests and optional checks count according to Usage.

Questions? Email