REST API
What it does
POTAL provides a RESTful JSON API with ~160 endpoints covering landed cost calculation, HS classification, sanctions screening, FTA lookup, and more. All endpoints use standard HTTP methods, return JSON responses, and include rate limit headers.
How to use it
Get your API key
Sign up at potal.app and create an API key from Dashboard > API Keys.
Authenticate requests
Include your API key in the X-API-Key or Authorization: Bearer header.
Call endpoints
Send JSON requests to https://potal.app/api/v1/{endpoint}. All responses include success, data, and meta fields.
Handle errors
Check the success field and HTTP status code. Error responses include a code and message for debugging.
API Reference
/api/v1Related Features
Secure API key authentication with scope-based permissions
Stable v1 API with backward-compatible versioning strategy
Full OpenAPI 3.0 specification for automated client generation
Interactive API docs with code examples in 5 languages
Intelligent rate limiting with per-plan quotas and burst support