Skip to main content

GET Member Broker Status

Read one member's stored Tradovate connection health. Only broker identities covered by an active grant appear. This endpoint uses your partner token and does not contact Tradovate.

Endpoint​

GET https://app.crosstrade.io/v1/api/partner/users/{external_id}/brokers

Headers​

NameRequiredValue
AuthorizationYesBearer <partner access token> with partner:read (also implied by partner:provision)

Path parameters​

NameTypeRequiredDescription
external_idstringYesMember id used at creation; 1–64 ASCII letters, digits, periods, underscores or hyphens

No query parameters or request body.

Code examples​

Set PARTNER_TOKEN and replace th_8831 with your member id.

import json
import os
import requests

response = requests.get(
"https://app.crosstrade.io/v1/api/partner/users/th_8831/brokers",
headers={"Authorization": f"Bearer {os.environ['PARTNER_TOKEN']}"},
timeout=15,
)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))

Response​

200 OK. The record is under member, with the same fields as each item from GET Broker Status. This response has no pagination, as_of field or membership ETag.

{
"success": true,
"member": {
"external_id": "th_8831",
"uid": "k3Qz9pLa",
"status": "connected",
"grant": {
"version": 1,
"active": true
},
"brokers": [
{
"environment": "demo",
"user_id": "4815162",
"name": "jamie_r",
"status": "ready",
"reason": null,
"expires": "2026-10-16T09:12:00Z",
"linked": "2026-10-15T14:08:40Z"
}
],
"all_ready": true
},
"meta": {
"requestId": "preq_1c2d3e4f5a6b7089"
}
}

Broker states are ready, reauth_required, unknown or unlinked; see connection states for their meanings. all_ready requires at least one shared login. A revoked member or member without shared identities returns brokers: [] and all_ready: false.

Membership status: connected describes consent, not broker health. If a login needs reauthorization, issue a relink Connect URL. Use the member's token for Trading and Management requests; ready does not bypass their authorization checks.

Errors​

StatusErrorMeaning
400validation_failedMalformed external id, unsupported query parameter or unexpected body
401unauthorizedInvalid partner token
403insufficient_scope, partner_not_enabled, partner_disabledScope or service policy refuses the read
404member_not_foundUnknown member
429rate_limited, too_many_concurrent_requestsHonor Retry-After
503storage_unavailable, policy_unavailable, auth_unavailable, partner_api_unavailableRetry with backoff

See Partner errors for response shapes.