Skip to content
Clear Street Clear Street Clear Street
Start Trading
API Reference
V1
Omni AI
Entitlements

Get Entitlement Status

v1.omni_ai.entitlements.get_entitlement_status(EntitlementGetEntitlementStatusParams**kwargs) -> EntitlementGetEntitlementStatusResponse
GET/v1/omni-ai/entitlement-status

Whether each entitlement is enabled, per account. Accounts with no recorded choice are enabled by default. Without account_id, covers every account the caller can access.

ParametersExpand Collapse
account_id: Optional[int]
ReturnsExpand Collapse
class EntitlementGetEntitlementStatusResponse: …
account_id: int
enabled: bool
entitlement_code: EntitlementCode

Stable entitlement code granted by an agreement.

Get Entitlement Status

from clearstreet import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.omni_ai.entitlements.get_entitlement_status()
print(response)
{
  "data": [
    {
      "account_id": 100019,
      "enabled": true,
      "entitlement_code": "omni.account_data"
    },
    {
      "account_id": 100021,
      "enabled": false,
      "entitlement_code": "omni.account_data"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
  }
}
Returns Examples
{
  "data": [
    {
      "account_id": 100019,
      "enabled": true,
      "entitlement_code": "omni.account_data"
    },
    {
      "account_id": 100021,
      "enabled": false,
      "entitlement_code": "omni.account_data"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
  }
}