API Overview
The Freeq API lets you authenticate, manage organisations/projects, work with wallets and inventory, issue tokens/memberships, record events, and receive webhooks. This overview gives you the base URL, error model, and a map of the key resources to explore next.
Testing Environment
The Testnet API is designed for manual functional testing only. It is not approved for automated, load, stress, or performance testing. For production workloads, contact support for mainnet access.
Base URL
https://api.testnet.superfreeq.com
Authentication
Most endpoints require a bearer token. See Authentication.
Resources
- Auth & Keys - Authentication, API Keys
- Orgs & Projects - Organisations, Projects, Project Members
- Wallets & Inventory - Wallets, Wallet Transactions, Inventory
- Tokens & Memberships - Token Issuance, Membership
- Events & Webhooks - User Behaviour Events (Client), User Behaviour Events (Admin), Webhooks
- Contracts - Contracts
- Utility - Public Endpoints
Errors
| Code | Meaning |
|---|---|
| 200 | OK |
| 201 | Created |
| 202 | Accepted (async) |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 409 | Conflict |
| 500 | Internal error |
tip
In bash, set env vars once and reuse them:
export FREEQ_API_URL="https://api.testnet.superfreeq.com"
export FREEQ_PROJECT_KEY="YOUR_PROJECT_KEY"
export FREEQ_API_TOKEN="YOUR_JWT_TOKEN"
Use FREEQ_API_TOKEN as a Bearer token in all protected requests.