Authentication

Public data API authentication

Every public Prontiq data API request requires an API key in the X-Api-Key header.

curl "https://api.prontiq.dev/v1/address/autocomplete?q=test" \
  -H "X-Api-Key: YOUR_API_KEY"

Create keys in the Prontiq console. Raw keys are revealed once, so copy the key into your secret manager or server environment when it is created.

Do not expose API keys in client-side code. Browser and mobile apps should call your backend, and your backend should call Prontiq.

Server-side examples

const response = await fetch("https://api.prontiq.dev/v1/address/autocomplete?q=test", {
  headers: { "X-Api-Key": process.env.PRONTIQ_API_KEY ?? "" },
});

import os
import requests

response = requests.get(
    "https://api.prontiq.dev/v1/address/autocomplete",
    params={"q": "test"},
    headers={"X-Api-Key": os.environ["PRONTIQ_API_KEY"]},
)

Missing key

If the X-Api-Key header is absent, the API returns 401 MISSING_API_KEY.

{
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Missing X-Api-Key header",
    "status": 401,
    "request_id": "req_abc123..."
  }
}

Invalid key

If the key is unknown, inactive, or malformed, the API returns 401 INVALID_API_KEY.

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key",
    "status": 401,
    "request_id": "req_abc123..."
  }
}

Product access

If your account is authenticated but does not have access to the requested API family, the API returns 403 PRODUCT_NOT_ALLOWED.

{
  "error": {
    "code": "PRODUCT_NOT_ALLOWED",
    "message": "Product not included in your plan",
    "status": 403,
    "request_id": "req_abc123...",
    "details": {
      "product": "address",
      "allowed": []
    }
  }
}

details.product is the API family requested by the route. details.allowed contains the API families currently enabled for the key’s account, so the requested product is absent when this error is returned.

Request IDs

Every response includes an X-Request-Id header. Error bodies also include the same value as error.request_id. Include this id when contacting support.

Console routes use Clerk, not API keys

Console account routes authenticate with a Clerk session token instead of X-Api-Key. They are private console routes, not public data API routes, and they are not included in the public API reference or public SDKs.

API-key authentication is separate from console authentication. Use API keys for public data API requests, and use the console for account and billing management.

Getting Started

Address API

SDKs

Public data API authentication

Server-side examples

Missing key

Invalid key

Product access

Request IDs

Console routes use Clerk, not API keys

​Public data API authentication

​Server-side examples

​Missing key

​Invalid key

​Product access

​Request IDs

​Console routes use Clerk, not API keys

Public data API authentication

Server-side examples

Missing key

Invalid key

Product access

Request IDs

Console routes use Clerk, not API keys