Get Account By ID

$ clear-street v1:accounts get-account-by-id

GET/v1/accounts/{account_id}

Fetch account details by ID

ParametersExpand Collapse

--account-id: number

Account identifier

ReturnsExpand Collapse

V1AccountGetAccountByIDResponse: BaseResponse { metadata, error }

data: object { id, account_holder_entity_id, full_name, 7 more }

Represents a trading account

id: number

The unique identifier for the account

account_holder_entity_id: number

The account holder entity identifier

full_name: string

The full legal name of the account

open_date: string

The date the account was opened

options_level: number

The options level of the account

short_name: string

The short name of the account

status: "ACTIVE" or "INACTIVE" or "CLOSED"

The current status of the account

"ACTIVE"

"INACTIVE"

"CLOSED"

subtype: "CASH" or "MARGIN" or "OTHER"

The sub-type of account

"CASH"

"MARGIN"

"OTHER"

type: "CUSTOMER" or "OTHER"

The type of account

"CUSTOMER"

"OTHER"

close_date: optional string

The date the account was closed, if applicable

Get Account By ID

clear-street v1:accounts get-account-by-id \
  --api-key 'My API Key' \
  --account-id 0

{
  "data": {
    "account_holder_entity_id": 987654321,
    "close_date": null,
    "full_name": "Test Trading Account",
    "id": 19816,
    "open_date": "2023-01-15",
    "short_name": "TST-ACCOUNT-01",
    "status": "ACTIVE",
    "subtype": "MARGIN",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "data": {
    "account_holder_entity_id": 987654322,
    "close_date": "2024-08-01",
    "full_name": "Old Test Account",
    "id": 19817,
    "open_date": "2021-05-20",
    "short_name": "TST-ACCOUNT-02-CLOSED",
    "status": "CLOSED",
    "subtype": "CASH",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "c8f3e4a5-b2c3-5d4e-9f0a-6b7c8d9e0f1a"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "67e95eb4-93b9-4010-8c9b-7ada7c2be93f"
  }
}

Returns Examples

{
  "data": {
    "account_holder_entity_id": 987654321,
    "close_date": null,
    "full_name": "Test Trading Account",
    "id": 19816,
    "open_date": "2023-01-15",
    "short_name": "TST-ACCOUNT-01",
    "status": "ACTIVE",
    "subtype": "MARGIN",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "b7e2d3f4-a1b2-4c3d-8e4f-5a6b7c8d9e0f"
  }
}

{
  "data": {
    "account_holder_entity_id": 987654322,
    "close_date": "2024-08-01",
    "full_name": "Old Test Account",
    "id": 19817,
    "open_date": "2021-05-20",
    "short_name": "TST-ACCOUNT-02-CLOSED",
    "status": "CLOSED",
    "subtype": "CASH",
    "type": "CUSTOMER"
  },
  "error": null,
  "metadata": {
    "request_id": "c8f3e4a5-b2c3-5d4e-9f0a-6b7c8d9e0f1a"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "67e95eb4-93b9-4010-8c9b-7ada7c2be93f"
  }
}