create_locate
Requests a short sale locate for a stock symbol and share quantity, with optional limit price and all-or-none flag. Unavailable in paper trading.
Instructions
Creates a locate request for a short sale. Requires a symbol and quantity. Optionally set a limit price and all-or-none flag. Not available in paper trading.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"symbol": "<symbol>",
"qty": "<qty>"
},
"name": "create_locate"
}
}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 client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||