Skip to main content

​
Availability

Trading accounts and broker credentials are available on all plans. Paper trading accounts can be used to test integrations and trading workflows without market exposure. Live broker account connectivity is available on Starter and Professional plans only. The organization’s billing tier also caps the number of broker connections. Create requests are rejected after that limit is reached.

​
Intended Purpose

Trading accounts represent broker accounts connected to Anthid. They provide the primary boundary for order routing, position management, connection monitoring, and trading controls. Each trading account is associated with one or more broker credentials that allow Anthid to establish and maintain connectivity with an external broker. A trading account acts as the parent resource for most trading-related APIs.

​
Access

User callers list trading accounts and credentials in their principal organization. Service-account callers with credential:read can list and read across organizations. Only organization admins can create, update, or delete trading accounts and broker credentials. Paper credentials are allowed for admins; live credentials additionally require the Trading Live entitlement. Decrypted credential access is limited to service-account callers with the credential:decrypt scope. Use metadata endpoints for normal application workflows.

​
Trading Accounts

Trading accounts represent individual broker accounts managed by Anthid. Each trading account contains:
  • Broker configuration
  • Connection state
  • Broker credentials
  • Orders
  • Positions
  • Controls
Trading accounts are uniquely scoped to an organization.

​
Credentials

Credentials are broker-specific authentication secrets used to establish connectivity with external broker systems. Credential payloads are stored as encrypted WorkOS Vault objects. Credential APIs allow clients to:
  • List credential metadata for a trading account
  • Retrieve credential metadata
  • Update credential configuration
  • Rotate credentials
  • Remove unused credentials
Credential metadata does not decrypt or return the underlying secret payload. Credential values should be treated as sensitive secrets and are only available through the service-account-only decrypted credential endpoint.

​
Credential Variants

The OpenAPI schema defines broker credential payload variants for:

​
Endpoint Groups

List endpoints support cursor-based pagination. Trading account listing also supports require_credentials.

​
Common Use Cases

  • Connect a new broker account
  • Rotate broker API credentials
  • Decommission broker accounts
  • Manage multiple trading environments
  • Separate paper and live trading accounts
  • Organize accounts by strategy or broker
  • Connections
  • Orders
  • Positions
  • Controls
  • Organizations

​
Support

For questions about authentication, request formats, or API behavior, contact support@anthid.com.