Locates

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

List Locate Rates

$ clst v1:locates get-locate-rates

GET/v1/locates/rates

Get Locate Rate

$ clst v1:locates get-locate-rate-by-id

GET/v1/locates/rates/{instrument_id}

List Locates

$ clst v1:locates get-locates

GET/v1/accounts/{account_id}/locates

Get Locate

$ clst v1:locates get-locate-by-id

GET/v1/accounts/{account_id}/locates/{id}

ModelsExpand Collapse

locate: object { account_id, client_request_id, effective_date, 9 more }

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

account_id: number

Account the locate is booked to.

client_request_id: string

Caller-assigned id of the locate request.

effective_date: string

New York calendar date the locate is in force for.

instrument_id: string

Instrument id.

locate_request_id: string

Engine-assigned locate request id.

requested_quantity: number

Number of shares requested.

status: "REQUESTED" or "ACCEPTED" or "REJECTED" or "EXPIRED"

Presented status of the locate.

"REQUESTED"

"ACCEPTED"

"REJECTED"

"EXPIRED"

locate_id: optional string

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

quantity: optional number

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

related_order_id: optional string

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

reserved_quantity: optional number

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

used_quantity: optional number

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

locate_list: array of Locate { account_id, client_request_id, effective_date, 9 more }

account_id: number

Account the locate is booked to.

client_request_id: string

Caller-assigned id of the locate request.

effective_date: string

New York calendar date the locate is in force for.

instrument_id: string

Instrument id.

locate_request_id: string

Engine-assigned locate request id.

requested_quantity: number

Number of shares requested.

status: "REQUESTED" or "ACCEPTED" or "REJECTED" or "EXPIRED"

Presented status of the locate.

"REQUESTED"

"ACCEPTED"

"REJECTED"

"EXPIRED"

locate_id: optional string

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

quantity: optional number

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

related_order_id: optional string

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

reserved_quantity: optional number

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

used_quantity: optional number

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

locate_rate: object { instrument_id, rate, as_of }

A locate borrow rate for an instrument.

instrument_id: string

Instrument id the rate applies to.

rate: string

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

as_of: optional string

When the rate was requested from the locates venue.

locate_rate_result: object { instrument, error, rate }

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

instrument: string

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

error: optional object { code, message, details }

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

code: number

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

message: string

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

details: optional array of map[unknown]

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

rate: optional object { instrument_id, rate, as_of }

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

instrument_id: string

Instrument id the rate applies to.

rate: string

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

as_of: optional string

When the rate was requested from the locates venue.

locate_rate_result_list: array of LocateRateResult { instrument, error, rate }

instrument: string

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

error: optional object { code, message, details }

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

code: number

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

message: string

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

details: optional array of map[unknown]

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

rate: optional object { instrument_id, rate, as_of }

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

instrument_id: string

Instrument id the rate applies to.

rate: string

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

as_of: optional string

When the rate was requested from the locates venue.

locate_status: "REQUESTED" or "ACCEPTED" or "REJECTED" or "EXPIRED"

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

"REQUESTED"

"ACCEPTED"

"REJECTED"

"EXPIRED"