Locates

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

List Locate Rates

client.V1.Locates.GetLocateRates(ctx, query) (*V1LocateGetLocateRatesResponse, error)

GET/v1/locates/rates

Get Locate Rate

client.V1.Locates.GetLocateRateByID(ctx, instrumentID) (*V1LocateGetLocateRateByIDResponse, error)

GET/v1/locates/rates/{instrument_id}

List Locates

client.V1.Locates.GetLocates(ctx, accountID, query) (*V1LocateGetLocatesResponse, error)

GET/v1/accounts/{account_id}/locates

Get Locate

client.V1.Locates.GetLocateByID(ctx, id, query) (*V1LocateGetLocateByIDResponse, error)

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

ModelsExpand Collapse

type Locate struct{…}

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

AccountID int64

Account the locate is booked to.

formatint64

ClientRequestID string

Caller-assigned id of the locate request.

EffectiveDate Time

New York calendar date the locate is in force for.

formatdate

InstrumentID string

Instrument id.

formatuuid

LocateRequestID string

Engine-assigned locate request id.

formatuuid

RequestedQuantity int64

Number of shares requested.

formatint64

Status LocateStatus

Presented status of the locate.

One of the following:

const LocateStatusRequested LocateStatus = "REQUESTED"

const LocateStatusAccepted LocateStatus = "ACCEPTED"

const LocateStatusRejected LocateStatus = "REJECTED"

const LocateStatusExpired LocateStatus = "EXPIRED"

LocateID stringOptional

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 int64Optional

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

formatint64

RelatedOrderID stringOptional

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

formatuuid

ReservedQuantity int64Optional

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

formatint64

UsedQuantity int64Optional

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

formatint64

type LocateList []Locate

AccountID int64

Account the locate is booked to.

formatint64

ClientRequestID string

Caller-assigned id of the locate request.

EffectiveDate Time

New York calendar date the locate is in force for.

formatdate

InstrumentID string

Instrument id.

formatuuid

LocateRequestID string

Engine-assigned locate request id.

formatuuid

RequestedQuantity int64

Number of shares requested.

formatint64

Status LocateStatus

Presented status of the locate.

One of the following:

const LocateStatusRequested LocateStatus = "REQUESTED"

const LocateStatusAccepted LocateStatus = "ACCEPTED"

const LocateStatusRejected LocateStatus = "REJECTED"

const LocateStatusExpired LocateStatus = "EXPIRED"

LocateID stringOptional

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 int64Optional

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

formatint64

RelatedOrderID stringOptional

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

formatuuid

ReservedQuantity int64Optional

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

formatint64

UsedQuantity int64Optional

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

formatint64

type LocateRate struct{…}

A locate borrow rate for an instrument.

InstrumentID string

Instrument id the rate applies to.

formatuuid

Rate string

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

AsOf TimeOptional

When the rate was requested from the locates venue.

formatdate-time

type LocateRateResult struct{…}

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

Instrument InstrumentIDOrSymbol

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

minLength1

Error APIErrorOptional

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

Code int64

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

formatint32

minimum0

Message string

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

Details []map[string, any]Optional

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

Rate LocateRateOptional

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

InstrumentID string

Instrument id the rate applies to.

formatuuid

Rate string

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

AsOf TimeOptional

When the rate was requested from the locates venue.

formatdate-time

type LocateRateResultList []LocateRateResult

Instrument InstrumentIDOrSymbol

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

minLength1

Error APIErrorOptional

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

Code int64

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

formatint32

minimum0

Message string

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

Details []map[string, any]Optional

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

Rate LocateRateOptional

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

InstrumentID string

Instrument id the rate applies to.

formatuuid

Rate string

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

AsOf TimeOptional

When the rate was requested from the locates venue.

formatdate-time

type LocateStatus string

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

One of the following:

const LocateStatusRequested LocateStatus = "REQUESTED"

const LocateStatusAccepted LocateStatus = "ACCEPTED"

const LocateStatusRejected LocateStatus = "REJECTED"

const LocateStatusExpired LocateStatus = "EXPIRED"