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

Locates

Query locate requests, granted locates, and cached locate borrow rates.

List Locate Rates
v1.locates.get_locate_rates(LocateGetLocateRatesParams**kwargs) -> LocateGetLocateRatesResponse
GET/v1/locates/rates
Get Locate Rate
v1.locates.get_locate_rate_by_id(InstrumentIDOrSymbolinstrument_id) -> LocateGetLocateRateByIDResponse
GET/v1/locates/rates/{instrument_id}
List Locates
v1.locates.get_locates(intaccount_id, LocateGetLocatesParams**kwargs) -> LocateGetLocatesResponse
GET/v1/accounts/{account_id}/locates
Get Locate
v1.locates.get_locate_by_id(strid, LocateGetLocateByIDParams**kwargs) -> LocateGetLocateByIDResponse
GET/v1/accounts/{account_id}/locates/{id}
ModelsExpand Collapse
class Locate: …

A locate request joined with the locate granted for it, if any.

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[Locate]
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
class LocateRate: …

A locate borrow rate for an instrument.

instrument_id: str

Instrument id the rate applies to.

formatuuid
rate: str

Borrow rate, expressed as a decimal (e.g. 0.037012 for 3.7012%).

as_of: Optional[datetime]

When the rate was requested from the locates venue.

formatdate-time
class LocateRateResult: …

A requested instrument with either its cached borrow rate or an error.

The instrument id (UUID) or symbol, echoed exactly as requested, so each result maps back to its request.

minLength1
error: Optional[APIError]

Why no rate is present — a 404 when the instrument is unknown or has no cached rate. Omitted when rate is present.

code: int

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
message: str

A human-readable message providing more details about the error.

details: Optional[List[Dict[str, object]]]

Additional error details, if any. This can include structured information such as field violations or error metadata.

rate: Optional[LocateRate]

The cached borrow rate. Present when a rate was found; omitted when error is present.

instrument_id: str

Instrument id the rate applies to.

formatuuid
rate: str

Borrow rate, expressed as a decimal (e.g. 0.037012 for 3.7012%).

as_of: Optional[datetime]

When the rate was requested from the locates venue.

formatdate-time

The instrument id (UUID) or symbol, echoed exactly as requested, so each result maps back to its request.

minLength1
error: Optional[APIError]

Why no rate is present — a 404 when the instrument is unknown or has no cached rate. Omitted when rate is present.

code: int

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
message: str

A human-readable message providing more details about the error.

details: Optional[List[Dict[str, object]]]

Additional error details, if any. This can include structured information such as field violations or error metadata.

rate: Optional[LocateRate]

The cached borrow rate. Present when a rate was found; omitted when error is present.

instrument_id: str

Instrument id the rate applies to.

formatuuid
rate: str

Borrow rate, expressed as a decimal (e.g. 0.037012 for 3.7012%).

as_of: Optional[datetime]

When the rate was requested from the locates venue.

formatdate-time
Literal["REQUESTED", "ACCEPTED", "REJECTED", "EXPIRED"]

The presented status of a locate: the locate-request lifecycle plus EXPIRED for accepted locates whose effective date has passed.

One of the following:
"REQUESTED"
"ACCEPTED"
"REJECTED"
"EXPIRED"
class LocateGetLocateRatesResponse: …

The instrument id (UUID) or symbol, echoed exactly as requested, so each result maps back to its request.

minLength1
error: Optional[APIError]

Why no rate is present — a 404 when the instrument is unknown or has no cached rate. Omitted when rate is present.

code: int

The error code is used to identify the nature of the error. It corresponds to an HTTP status code.

formatint32
minimum0
message: str

A human-readable message providing more details about the error.

details: Optional[List[Dict[str, object]]]

Additional error details, if any. This can include structured information such as field violations or error metadata.

rate: Optional[LocateRate]

The cached borrow rate. Present when a rate was found; omitted when error is present.

instrument_id: str

Instrument id the rate applies to.

formatuuid
rate: str

Borrow rate, expressed as a decimal (e.g. 0.037012 for 3.7012%).

as_of: Optional[datetime]

When the rate was requested from the locates venue.

formatdate-time
class LocateGetLocateRateByIDResponse: …

A locate borrow rate for an instrument.

instrument_id: str

Instrument id the rate applies to.

formatuuid
rate: str

Borrow rate, expressed as a decimal (e.g. 0.037012 for 3.7012%).

as_of: Optional[datetime]

When the rate was requested from the locates venue.

formatdate-time
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
class LocateGetLocateByIDResponse: …
data: Locate

A locate request joined with the locate granted for it, if any.

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