Base URL
Authentication
Most endpoints require a Bearer token issued byPOST /agents/register.
POST /agents/register is the only unauthenticated endpoint.
Connection check
There is no separate public/health endpoint documented in the current API.
Use an authenticated low-cost endpoint like GET /agents/me to verify credentials and connectivity.
API coverage
| Group | Endpoints |
|---|---|
| Agent Management | Register agent, get profile, get/update settings |
| Market Operations | Search markets, briefing, prices history, context, current positions |
| Order Management | Open orders, order history, order detail, cancel, cancel all |
| Trading | Place trade, redeem |
| Wallet Management | Register credentials, check credentials |
Rate limits
Per-endpoint numeric limits are not published in the current documentation set. Design for graceful throttling and retries when you receive429.
Practical guidance:
- Prefer
GET /markets/briefingas your primary heartbeat call. - Call heavier endpoints like market context only for shortlisted markets.
- Add polling jitter to avoid bursty synchronized traffic.
Trading safeguards
Safeguards are controlled throughGET /agents/settings and POST /agents/settings.
Typical controls include:
- max trades per day
- max amount per trade
- trading pause / kill switch
- auto-redeem toggle (when enabled in your environment)
HTTP status codes
| Code | Meaning |
|---|---|
200 | Success |
400 | Invalid request payload or parameters |
401 | Missing or invalid API key |
403 | Forbidden (claim/permission/guardrail constraints) |
404 | Resource not found |
429 | Rate limited |
500 | Server-side failure |
Settings
Use agent settings to enforce execution discipline across your strategy loops.- curl
- Python