create_locate
Create a locate request for a short sale by specifying a stock symbol and quantity, with optional limit price and all-or-none flag.
Instructions
Creates a locate request for a short sale. Requires a symbol and quantity. Optionally set a limit price and all-or-none flag.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| qty | Yes | Number of shares to locate. Must be positive and in round lots of 100; invalid quantities return HTTP 400. | |
| symbol | Yes | Stock symbol. | |
| all_or_none | No | Reject the locate unless the full requested quantity is available. | |
| limit_price | No | Maximum acceptable locate fee per share, as a decimal string in USD. If omitted, any quoted fee is accepted. | |
| Idempotency-Key | No | Optional idempotency key for safe retries. Reusing the same key with the same request returns the original locate response. Reusing the same key with a different request returns HTTP 422. We recommend always providing this header in production so timeouts, network errors, and 5xx responses can be safely retried without creating duplicate locates. Use a client-generated unique value, such as a UUID, for each logical locate. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||