Shorted API
The Shorted API provides programmatic access to Australian Securities Exchange (ASX) short position data. This includes historical time series, industry-wide trends, and comprehensive company metadata.
Quick Start
Get up and running with our API in minutes with our cURL and SDK examples.
Authentication
Learn how to authenticate your requests using Bearer tokens or Session cookies.
Authentication
The Shorted API uses Bearer Tokens to authenticate requests. You can generate a personal access token directly from this dashboard if you are signed in.
Bearer Token
Include your API key in the Authorization header of your requests. All private endpoints require this header.
Public vs Private
Most metadata and summary endpoints are Public and do not require authentication. However, detailed time-series data and user-specific resources are Private.
- Public: GetStock, SearchStocks, GetTopShorts
- Private: GetStockData, MintToken
Rate Limits & Usage Policy
All API requests are subject to rate limiting. Limits vary by subscription tier and are enforced using a sliding window algorithm.
Rate Limit Tiers
These limits apply to programmatic API access (requests with API tokens). Browser access via shorted.com.au has more relaxed limits and is not subject to these caps.
| Tier | Per Minute | Per Month | Access |
|---|---|---|---|
| Anonymous | 10 | 500 | Public endpoints only, limited |
| Free (signed in) | 30 | 1,000 | All endpoints, requires API token |
| Pro ($29/mo) | 120 | 10,000 | All endpoints, priority |
| Enterprise | 300 | 50,000 | All endpoints, dedicated support |
Usage Policy
- Automated access requires a valid API token.
- Scraping without authentication is prohibited.
- Requests without valid
User-Agentheaders may be blocked. - Browser-tier rate limits only apply to requests originating from shorted.com.au.
- Abuse results in IP-level blocking.
- For bulk data access, contact enterprise@shorted.com.au.
Response Headers
All API responses include rate limit headers so you can monitor your usage programmatically.
X-RateLimit-Limit: 120 # Per-minute limit (0 = unlimited)X-RateLimit-Remaining: 115 # Requests remaining this minuteX-RateLimit-Reset: 1706918400 # Unix timestamp when minute window resetsX-RateLimit-Monthly-Limit: 10000 # Monthly request capX-RateLimit-Monthly-Used: 150 # Requests used this monthX-RateLimit-Monthly-Reset: 1709251200 # Start of next billing monthWhen rate limited, the API returns HTTP 429 Too Many Requests with a Retry-After header indicating how many seconds to wait.