Olympus API

Auth
- Retrieve a JWT token for use with the Olympus API.post
Locates
Rates
- /ratespost
- /bulk-ratespost

Locates FIX API

FIX Session: Preferred Message Flow
FIX Session: Legacy Message Flow

Managed SBL API

Auth
- Retrieve a JWT token for use with the Managed SBL APIspost
Inventory
- Get All Inventoryget
- Add Inventorypost
Orders
Contracts
Asset Servicing
- Get Corporate Actionsget
Pricing
- Get Indicative Ratesget
PNL Reporting
- Get Accrualsget
Locate Attribution
- Get Locate Attributionget
Payments
- Get Payments.get
Settlements
- Get Settlementsget

Olympus API

Auth
- Retrieve a JWT token for use with the Olympus API.post
Locates
Rates
- /ratespost
- /bulk-ratespost

Locates FIX API

FIX Session: Preferred Message Flow
FIX Session: Legacy Message Flow

Managed SBL API

Auth
- Retrieve a JWT token for use with the Managed SBL APIspost
Inventory
- Get All Inventoryget
- Add Inventorypost
Orders
Contracts
Asset Servicing
- Get Corporate Actionsget
Pricing
- Get Indicative Ratesget
PNL Reporting
- Get Accrualsget
Locate Attribution
- Get Locate Attributionget
Payments
- Get Payments.get
Settlements
- Get Settlementsget

/locates

patch https://api.clearstreet.io/sfin/v1/locates

Accept or decline a batch of locate orders. The response will contain a list of locate orders and their current status. If a locate order is filled, its response will also contain the locate ID.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Body Params

locates

array of objects

List of OFFERED locate orders to be accepted or declined

locates

Responses

Response body

object

locates

array of objects

locates

object

borrow_rate

number

The borrow rate for the security if held overnight

clst_reference_id

string

The Clear Street reference ID for the locate order

parent_clst_reference_id

string

The Clear Street reference ID of the parent Locate, if this order is a remainder order

desk_comment

string

Comments provided by the desk

expiry_time

date-time

The time the locate order will expire, set once the order has been processed.

locate_id

string

A unique ID for the locate order, available after the order has been OFFERED

located_quantity

integer

The quantity of shares that have been located

located_time

date-time

The time the security was located

mpid

string

The client Market Participant Identifier, assigned by Clear Street

reference_id

string

The reference ID provided by the client when submitting the locate order

request_time

date-time

The time the locate order was received from the client

requested_quantity

integer

The quantity of shares requested by the client

security_id

string

The security ID

security_id_type

string

The type of security ID

TICKER

total_cost

number

The total cost of the locate

trader_account

string

Optional client account number, assigned by Clear Street

trader_comment

string

Comments provided by the trader

status

string

The status of the locate order

PENDING OFFERED FILLED REJECTED DECLINED EXPIRED CANCELED

Response body

object

timestamp

date-time

RFC3339 formatted timestamp for the error

message

string

A message describing the error

401

The user is not authenticated.

403

The user is authenticated but does not have the permissions required for this operation.

Response body

object

timestamp

date-time

RFC3339 formatted timestamp for the error

message

string

A message describing the error

Updated about 1 year ago

/locates

/locates/{clst_reference_id}/{status}

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.clearstreet.io/sfin/v1/locates \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 1 year ago

/locates

/locates/{clst_reference_id}/{status}

Did this page help you?

Olympus API
Auth
Retrieve a JWT token for use with the Olympus API.post
Locates
/locates/{clst_reference_id}/{status}get
/locatespatch
/locatesget
/locatespost
Rates
/bulk-ratespost
/ratespost

Locates FIX API
FIX Session: Preferred Message Flow
FIX Session: Legacy Message Flow

Managed SBL API
Auth
Retrieve a JWT token for use with the Managed SBL APIspost
Inventory
Add Inventorypost
Get All Inventoryget
Orders
Reject Orderspost
Approve Orderspost
Submit Orderspost
Get Borrow Orders for reviewget
Contracts
Get Contract Returnsget
Submit Contract Recallspost
Cancel Contract Recallpost
Add Recalls By Securitypost
Get Recallsget
Add Recalls By Contractpost
Get Contract Ratesget
Get Contract Marksget
Get loan Contractsget
Asset Servicing
Get Corporate Actionsget
Pricing
Get Indicative Ratesget
PNL Reporting
Get Accrualsget
Locate Attribution
Get Locate Attributionget
Payments
Get Payments.get
Settlements
Get Settlementsget

Olympus API
Auth
Retrieve a JWT token for use with the Olympus API.post
Locates
/locates/{clst_reference_id}/{status}get
/locatespatch
/locatesget
/locatespost
Rates
/bulk-ratespost
/ratespost

Locates FIX API
FIX Session: Preferred Message Flow
FIX Session: Legacy Message Flow

Managed SBL API
Auth
Retrieve a JWT token for use with the Managed SBL APIspost
Inventory
Add Inventorypost
Get All Inventoryget
Orders
Reject Orderspost
Approve Orderspost
Submit Orderspost
Get Borrow Orders for reviewget
Contracts
Get Contract Returnsget
Submit Contract Recallspost
Cancel Contract Recallpost
Add Recalls By Securitypost
Get Recallsget
Add Recalls By Contractpost
Get Contract Ratesget
Get Contract Marksget
Get loan Contractsget
Asset Servicing
Get Corporate Actionsget
Pricing
Get Indicative Ratesget
PNL Reporting
Get Accrualsget
Locate Attribution
Get Locate Attributionget
Payments
Get Payments.get
Settlements
Get Settlementsget

200List of locate orders with updated statuses

400The request is malformed.

404The requested resource was not found.