Skip to main content

GET Partner Profile

Read your service's current policy before provisioning members or enabling live access. This describes the partner identified by your token.

Endpoint​

GET https://app.crosstrade.io/v1/api/partner/me

Headers​

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

No path parameters, query parameters or request body. Obtain your token through Partner Authentication.

Code examples​

Set PARTNER_TOKEN to your service's access token.

import json
import os
import requests

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

Response​

200 OK. Limits below are illustrative; use the values returned for your partner.

{
"success": true,
"partner": {
"id": "p_8f1c2d3e",
"slug": "acme_signals",
"name": "Acme Signals, LLC",
"status": "active",
"environments": [
"demo"
],
"seat_cap": 500,
"open_seats": 12,
"limits": {
"requests_per_minute": 600,
"reduction_requests_per_minute": 120,
"max_inflight": 4,
"max_identities_per_member": 2,
"max_accounts_per_member": 10,
"max_automation_per_member": 5
},
"stripe_mode": "live",
"live_enabled": false,
"billing": {
"status": "active",
"verified": true,
"grace_expires_at": null
},
"policy": {
"allows_new_seats": true,
"allows_entries": true,
"allows_reads": true
}
},
"meta": {
"requestId": "preq_4d3c2b1a09f8e7d6"
}
}
FieldMeaning
statusEffective service state: provisioning, active, past_due, suspended or disabled
environments, live_enabledEnvironments configured for your partner and whether delegated live access is enabled
seat_cap, open_seatsMaximum funded seats and seats currently open
limitsShared per-partner budgets; requests can have different costs
billingBilling status, verification and any grace deadline
policyWhether the effective service state permits new seats, trading entries and reads

Errors​

StatusErrorMeaning
400validation_failedA body or unsupported query parameter was supplied
401unauthorizedPartner token missing, expired, revoked or for another audience
403insufficient_scope, partner_not_enabled, partner_disabledScope or service policy refuses the read
429rate_limited, too_many_concurrent_requestsWait at least Retry-After seconds
503partner_api_unavailable, policy_unavailable, auth_unavailableAPI or authentication dependency unavailable

See Partner errors for the common error envelope and recovery rules.