Skip to main content
When a trading account is connected to a broker, Anthid establishes a persistent worker connection that maintains authentication, monitors account health, and synchronizes broker state with the platform. This worker is represented by a trading account connection status. Connection APIs provide visibility into the worker’s current status, allowing clients to determine whether the broker is reachable and the integration is operating normally.

​
Availability

Available on all plans.

​
Intended Purpose

Use connection APIs to:
  • List connection statuses for accounts visible to the caller
  • Verify broker connectivity for a single trading account
  • Monitor active and pending connection health
  • Troubleshoot broker integration issues
The caller must have intent read authorization. User and API-key callers list accounts in their principal organization; service-account callers may list accounts visible to the service credentials.

​
Endpoints

​
Status response

Each status includes the account ID, current state, and two timestamps:
An error state is represented as an object, for example "status": {"Error": "authentication failed"}. Other states are strings.

​
Connection lifecycle

  1. Create a trading account
  2. Configure broker credentials
  3. Establish broker connectivity
  4. Monitor connection status
  5. Execute trading activity

​
Connection states

A connection may report:

​
Polling considerations

Connection status represents the most recent state observed by the platform. Compare last_edit_at with last_update_at when deciding whether a status reflects the most recent account change. Status information may lag broker-side events depending on broker update frequency and network conditions.

​
Common use cases

  • Display broker health in dashboards
  • Verify readiness before submitting orders
  • Alert operators to broker outages
  • Audit connection stability

​
Support

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