GET
/v3/reference/options/contracts/{options_ticker}
Options Contract Overview
Get details for a specific options contract.
Endpoint Details
| HTTP Method |
GET |
| Path |
/v3/reference/options/contracts/{options_ticker} |
| Version |
v3 |
| Minimum Plan |
free |
Path Parameters
| Parameter |
Required |
Description |
Example |
options_ticker |
Required |
The options contract ticker symbol |
O:AAPL230616C00150000 |
Query Parameters
| Parameter |
Type |
Required |
Description |
api_key |
string |
Required |
Your API key for authentication |
asset_class |
string |
Optional
|
Filter by asset class (stocks, options, forex, crypto) |
locale |
string |
Optional
|
Filter by locale/market (default: us) |
limit |
integer |
Optional
|
Maximum number of results |
cursor |
string |
Optional
|
Pagination cursor for next page |
Example Request
curl "https://mail.tradeiqai.com/api/v3/reference/options/contracts/O:AAPL230616C00150000?api_key=YOUR_API_KEY"
Note: Replace YOUR_API_KEY with your actual API key.
Response Attributes
| Attribute |
Type |
Description |
ok |
boolean |
Indicates if the request was successful |
data.status |
string |
The status of the request response (typically "OK") |
data.request_id |
string |
A unique request ID assigned by the server |
data.results |
object|array |
Object or array containing endpoint-specific data |
data.next_url |
string (optional) |
URL for pagination to fetch the next page of results |
Example Response
{
"ok": true,
"data": {
"status": "OK",
"request_id": "abc123def456...",
"results": {
// Endpoint-specific data structure
},
"next_url": "https://api.tradeiqai.com/...?cursor=xyz789"
}
}