Sign in

v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-03-03327794.1 KB
Locates

Create locate order

Create locate order to borrow inventory for short-selling.

post/accounts/{account_id}/locate-orders

Path parameters

account_idstring required

Account ID for the account.

Example:100000

Request body

symbolstring required
quantitystring required

String representation of quantity.

mpidstring required

The market participant where the locate will be sent.

reference_idstring required

An ID that you provide.

commentsstring

Any additional comments for the locate request.

Example request

{
  "symbol": "AAPL",
  "quantity": "100",
  "reference_id": "my-order-id-123"
}

Response

Locate order successfully created

locate_order_idstring required

Unique locate ID assigned by us.

requested_atinteger required

Milliseconds since epoch.

updated_atinteger required

Milliseconds since epoch.

mpidstring required

Unique MPID assigned by us.

account_idstring required

Account ID for the account.

account_numberstring required

Account number for the account.

symbolstring required
status'pending' | 'offered' | 'filled' | 'rejected' | 'declined' | 'expired' | 'cancelled' required

The status of the locate order.

requested_quantitystring required

String representation of quantity.

locate_idstring

Unique locate ID assigned by us.

located_atinteger

Milliseconds since epoch.

expires_atinteger

Milliseconds since epoch.

borrow_ratestring

String representation of a rate.

located_quantitystring

String representation of quantity.

total_coststring

String representation of a price.

desk_commentstring

Comment from the desk.

trader_commentstring

Comment from the trader.

reference_idstring

An ID that you provide.

Example response

{
  "locate_order_id": "12390213",
  "mpid": "CLST",
  "account_id": "100000",
  "account_number": "ACC0001",
  "symbol": "AAPL",
  "requested_quantity": "100",
  "locate_id": "12390213",
  "borrow_rate": "0.23",
  "located_quantity": "100",
  "total_cost": "123.99",
  "reference_id": "my-order-id-123"
}