REST API¶

The ApiCrate REST API provides direct HTTP access to all services. Base URL: https://api.apicrate.io

Base URL¶

All endpoints are served under:

https://api.apicrate.io/api/v1/

Authentication¶

Every request must include one of:

X-API-Key header with your API key
Authorization: Bearer <jwt> header with a JWT token

See Authentication for details on obtaining and managing keys.

# API key
curl -H "X-API-Key: ac_usr_..." https://api.apicrate.io/api/v1/ip/me

# JWT
curl -H "Authorization: Bearer eyJ..." https://api.apicrate.io/api/v1/ip/me

Common Features¶

Field Filtering¶

Most endpoints support a fields query parameter to return only specific fields in the response:

curl -H "X-API-Key: $KEY" \
  "https://api.apicrate.io/api/v1/countries/US?fields=name,capital"

Pagination¶

List endpoints accept limit and offset query parameters:

curl -H "X-API-Key: $KEY" \
  "https://api.apicrate.io/api/v1/countries?limit=10&offset=20"

Rate Limiting¶

Every response includes quota headers:

X-Quota-Limit – credits available in your current window
X-Quota-Remaining – requests left in current window
X-Quota-Reset – Unix timestamp when your quota window resets

When the quota is exceeded the API returns HTTP 429.

Response Format¶

All responses are JSON with Content-Type: application/json.

Endpoints¶

Domain	Endpoints	Description
User Agents	3	Parse User-Agent strings into browser, OS, and device data
IP Geolocation	3	Geolocate IPs to country, city, ISP; detect VPN/proxy/Tor
Countries	6	ISO 3166 country and subdivision lookup
Postal Codes	9	Postal code lookup, validation, and spatial queries
Timezones	4	Timezone info, conversion, and difference calculation
Hashing	7	Cryptographic digest and password KDF hashing
Bible	11	Bible verse retrieval, search, and navigation
Email Risk	2	Email validation and fraud risk scoring