Keys and test mode
Every REST call carries an API key as a bearer token: sk_live_ for live data,
sk_test_ for test mode. Admins create keys in the app under Settings, Organization.
Platform
Keys and test mode, versioning, events and webhooks, refusals, rate limits.
Versioning
Send Trade-HQ-Version: 2026-10-01. the request's header, then the API key's pin, then the current version; every response says which served it in the same header.
Events and webhooks
What each capability emits, and whether a webhook delivers it today.
Events ›Refusals and rate limits
Every refusal is one envelope with a closed code. A 429 is rate_limited.
SDKs
TypeScript (@containertradehq/sdk) and Python (containertradehq), generated from
the same registry as this reference. Not yet published to npm or PyPI.
API status
The status page is not yet published.
58 capabilities
| Name | What it does | Authority |
|---|---|---|
| advance_flag_wave | Advance a flag to its next wave | act |
| announce_deprecated_versions | Announce deprecated API versions | act |
| confirm_report | Confirm a report works now | act |
| create_api_key | Create an API key | act |
| create_service_account | Create a service account | act |
| delete_view | Delete a saved view | act |
| disable_service_account | Disable a service account | act |
| follow_report | Follow a customer report | act |
| get_api_usage | Get API usage | read |
| get_report | Get a customer report | read |
| get_tenant_health | Get tenant health | read |
| get_test_twin | Get an org's test twin | read |
| get_view | Open a saved view | read |
| get_view_default | Get the view in force | read |
| grant_capability | Grant a capability to an org | act |
| list_announcements | List what is showing to an org | read |
| list_api_keys | List API keys | read |
| list_beta_lists | Beta lists | read |
| list_beta_members | Beta testers and who agreed | read |
| list_capability_events | List capability events and their delivery | read |
| list_flag_actions | List the flag changes made from the Flags page | read |
| list_flag_staff | Staff by name, for the Flags page | read |
| list_flags | List the feature flags | read |
| list_fx_rates | List FX rates | read |
| list_granted_capabilities | List an org's capability grants | read |
| list_report_opens | List my report opens | read |
| list_reports | List customer reports | read |
| list_saved_views | List saved views | read |
| list_service_accounts | List service accounts | read |
| mark_report_seen | Mark a customer report seen | act |
| pin_view | Pin a saved view to a tab's Home | act |
| provision_sandbox | Provision a sandbox | act |
| publish_announcement | Publish an announcement to one account | act |
| record_report_open | Record a report open | act |
| reopen_report | Report it again: still broken | act |
| replay_event_delivery | Replay an event's delivery | act |
| reply_to_report | Reply to a report | act |
| revoke_api_key | Revoke an API key | act |
| revoke_capability_grant | Revoke a capability grant | act |
| roll_back_flag | Roll a flag back to staff only | act |
| rotate_api_key | Rotate an API key | act |
| save_view | Save a view | act |
| send_feedback | Send feedback or report a problem | act |
| set_api_key_limits | Set an API key's limits | act |
| set_api_key_version | Set an API key's version | act |
| set_beta_list_member | Add or remove an org or user on a beta list | act |
| set_flag_lists | Choose the beta lists a flag reaches | act |
| set_fx_rate_override | Override an FX rate | act |
| set_maintenance_banner | Set the maintenance banner | act |
| set_my_view_default | Set my default view | act |
| set_org_view_default | Set the org default view | act |
| set_session_mode | Switch between live and test | act |
| share_view | Share a saved view | act |
| step_back_flag | Roll a flag back one wave | act |
| summarize_reports | Summarize customer reports | read |
| turn_off_flag | Turn a flag off | act |
| unfollow_report | Unfollow a customer report | act |
| update_service_account | Update a service account | act |
Devices: registered devices and the pushes they receive.