Skip to content
Clear Street Clear Street Clear Street
Start Trading
API Reference
V1
Locates

List Locates

v1.locates.get_locates(intaccount_id, LocateGetLocatesParams**kwargs) -> LocateGetLocatesResponse
GET/v1/accounts/{account_id}/locates

List locates for the account on one effective date, which defaults to today’s New York calendar date. Filter by comma-separated statuses and instrument ids or symbols.

ParametersExpand Collapse
account_id: int
effective_date: Optional[Union[null, null]]

Effective date to list; defaults to today’s New York calendar date. Explicit dates are used unchanged, including weekends and holidays.

formatdate
instrument_ids: Optional[Sequence[InstrumentIDOrSymbol]]

Comma-separated instrument IDs (UUID) or symbols.

status: Optional[List[Literal["REQUESTED", "ACCEPTED", "REJECTED", "EXPIRED"]]]

Comma-separated locate statuses to filter by

One of the following:
"REQUESTED"
"ACCEPTED"
"REJECTED"
"EXPIRED"
ReturnsExpand Collapse
class LocateGetLocatesResponse: …
account_id: int

Account the locate is booked to.

formatint64
client_request_id: str

Caller-assigned id of the locate request.

effective_date: date

New York calendar date the locate is in force for.

formatdate
instrument_id: str

Instrument id.

formatuuid
locate_request_id: str

Engine-assigned locate request id.

formatuuid
requested_quantity: int

Number of shares requested.

formatint64
status: LocateStatus

Presented status of the locate.

One of the following:
"REQUESTED"
"ACCEPTED"
"REJECTED"
"EXPIRED"
locate_id: Optional[str]

Engine-assigned locate id; set once the locate is granted. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
quantity: Optional[int]

Number of shares granted; set once the locate is granted. When a null/undefined value is observed, it indicates it does not apply.

formatint64

Client order id the request relates to, if any. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
reserved_quantity: Optional[int]

Number of granted shares reserved. When a null/undefined value is observed, it indicates it does not apply.

formatint64
used_quantity: Optional[int]

Number of granted shares already used. When a null/undefined value is observed, it indicates it does not apply.

formatint64

List Locates

from clearstreet import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.locates.get_locates(
    account_id=0,
)
print(response)
{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 1,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 42,
    "total_pages": 5
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": [
    {
      "account_id": 0,
      "client_request_id": "client_request_id",
      "effective_date": "2019-12-27",
      "instrument_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "locate_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "requested_quantity": 0,
      "status": "REQUESTED",
      "locate_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "quantity": 0,
      "related_order_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "reserved_quantity": 0,
      "used_quantity": 0
    }
  ]
}
Returns Examples
{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 1,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 42,
    "total_pages": 5
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": [
    {
      "account_id": 0,
      "client_request_id": "client_request_id",
      "effective_date": "2019-12-27",
      "instrument_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "locate_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "requested_quantity": 0,
      "status": "REQUESTED",
      "locate_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "quantity": 0,
      "related_order_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "reserved_quantity": 0,
      "used_quantity": 0
    }
  ]
}