Indexer API
List shorts
Each open short, its position and its health, at the index's head.
GET
/v1/shortsThe shorts are every account and Stock Token that ever emitted Sell and still hold borrow shares.
The public tier allows 10 requests a second per client. Beyond it, send an X-API-Key or pay for each request in USDG. See the overview.
Response
200 The open shorts.
blockintegeralways present
shortsobject[]always present
accountaddressalways present
symbolstringalways present
positionobjectalways present
usdgHeldinteger stringalways present
debtinteger stringalways present
sharesinteger stringalways present
epoch_integer stringalways present
healthHealthalways present
Errors
| 401 | An X-API-Key the operator did not issue. |
| 402 | Over the public tier's rate, where the operator sells the requests beyond it. The PAYMENT-REQUIRED header is the base64 of a JSON document of x402's version 2: what a request costs in USDG, and to whom, on which chain. Repeat the request with PAYMENT-SIGNATURE, the base64 of the payment signed for it; it is served once the payment settles, and its PAYMENT-RESPONSE header is the settlement. |
| 404 | Why the request was not served. |
| 429 | Over the tier's rate. |
| 502 | Why the request was not served. |
| 503 | Why the request was not served. |