Equity Rank Options API
The options API from Equity Rank — 11 operation(s) for options.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/equity-rank-com:equity-rank-com-options-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Equity Rank Com Options API
version: 0.1.0
description: 'Operations tagged options across 2 of this provider''s published API definitions: openapi.json, equity-rank-com-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Options
paths:
/api/options/{symbol}/expirations:
get:
tags:
- Options
summary: Get Expirations
description: List available option expiry dates for a symbol.
operationId: get_expirations_api_options__symbol__expirations_get
security:
- HTTPBearer: []
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Expirations Api Options Symbol Expirations Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/options/{symbol}/chain:
get:
tags:
- Options
summary: Get Chain
description: 'Return the options chain for a symbol and expiry date.
Optionally filter by side (''call'' or ''put'').
Contracts are sorted by strike ascending.
If stock_price is provided, BSM fair value and delta are computed for each contract.'
operationId: get_chain_api_options__symbol__chain_get
security:
- HTTPBearer: []
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
- name: expiry
in: query
required: true
schema:
type: string
description: Expiry date YYYY-MM-DD
title: Expiry
description: Expiry date YYYY-MM-DD
- name: side
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '''call'' or ''put'', omit for both'
title: Side
description: '''call'' or ''put'', omit for both'
- name: stock_price
in: query
required: false
schema:
type: number
description: Current stock price for BSM enrichment
default: 0.0
title: Stock Price
description: Current stock price for BSM enrichment
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Chain Api Options Symbol Chain Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/options/{symbol}/summary:
get:
tags:
- Options
summary: Get Summary
description: Return IV rank, IV percentile, put/call ratio, volume/OI totals, and implied move fields.
operationId: get_summary_api_options__symbol__summary_get
security:
- HTTPBearer: []
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
- name: stock_price
in: query
required: false
schema:
type: number
description: Current stock price for implied move calc
default: 0.0
title: Stock Price
description: Current stock price for implied move calc
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Summary Api Options Symbol Summary Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/options/{symbol}/earnings-play:
get:
tags:
- Options
summary: Get Earnings Play
description: 'Earnings play analysis: next date, IV crush estimate, recommended strategy.'
operationId: get_earnings_play_api_options__symbol__earnings_play_get
security:
- HTTPBearer: []
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
- name: stock_price
in: query
required: false
schema:
type: number
description: Current stock price for implied move calc
default: 0.0
title: Stock Price
description: Current stock price for implied move calc
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Earnings Play Api Options Symbol Earnings Play Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/options/{symbol}/recommendations:
get:
tags:
- Options
summary: Get Recommendations
description: 'Generate an AI strategy recommendation for options on this symbol.
Fetches IV summary and chain, finds ATM options, then runs the
rules-based recommendations engine.
Query params:
stock_price — required, current stock price
rank_score — EquityRank total score (default 50)
momentum_score — momentum pillar score (default 50)
quality_score — quality pillar score (default 50)
expiry — if provided, use this expiry for ATM price lookup'
operationId: get_recommendations_api_options__symbol__recommendations_get
security:
- HTTPBearer: []
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
- name: stock_price
in: query
required: true
schema:
type: number
description: Current stock price
title: Stock Price
description: Current stock price
- name: rank_score
in: query
required: false
schema:
type: number
description: EquityRank total score 0-100
default: 50.0
title: Rank Score
description: EquityRank total score 0-100
- name: momentum_score
in: query
required: false
schema:
type: number
description: Momentum pillar score 0-100
default: 50.0
title: Momentum Score
description: Momentum pillar score 0-100
- name: quality_score
in: query
required: false
schema:
type: number
description: Quality pillar score 0-100
default: 50.0
title: Quality Score
description: Quality pillar score 0-100
- name: consensus_margin_of_safety
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Consensus MOS % (negative = overvalued)
title: Consensus Margin Of Safety
description: Consensus MOS % (negative = overvalued)
- name: expiry
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Target expiry YYYY-MM-DD for ATM data
title: Expiry
description: Target expiry YYYY-MM-DD for ATM data
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Recommendations Api Options Symbol Recommendations Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/options/{symbol}/analysis:
get:
tags:
- Options
summary: Get Analysis
description: 'Combined options analysis in a single call:
- IV rank, PCR, implied move (summary)
- Strategy recommendation with rationale and payoff math
- IV mispricing scan (BSM vs market mid, top 5 candidates)
On success: result is cached to analysis_cache for offline/budget fallback.
On failure: serves the most-recent cached result if available.
The frontend calls this once per symbol load; no further options endpoints needed.'
operationId: get_analysis_api_options__symbol__analysis_get
security:
- HTTPBearer: []
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
- name: stock_price
in: query
required: true
schema:
type: number
description: Current stock price
title: Stock Price
description: Current stock price
- name: rank_score
in: query
required: false
schema:
type: number
description: EquityRank total score 0-100
default: 50.0
title: Rank Score
description: EquityRank total score 0-100
- name: momentum_score
in: query
required: false
schema:
type: number
description: Momentum pillar score 0-100
default: 50.0
title: Momentum Score
description: Momentum pillar score 0-100
- name: quality_score
in: query
required: false
schema:
type: number
description: Quality pillar score 0-100
default: 50.0
title: Quality Score
description: Quality pillar score 0-100
- name: consensus_margin_of_safety
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Consensus MOS % (negative = overvalued)
title: Consensus Margin Of Safety
description: Consensus MOS % (negative = overvalued)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Analysis Api Options Symbol Analysis Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/options/{symbol}/iv-crush-estimate:
get:
tags:
- Options
summary: Get Iv Crush Estimate
description: 'Return the best available IV crush % estimate for this ticker.
Uses historical per-ticker data (≥3 events), sector average (≥5), or 35% heuristic fallback.'
operationId: get_iv_crush_estimate_api_options__symbol__iv_crush_estimate_get
security:
- HTTPBearer: []
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
- name: sector
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Sector for sector-level fallback
title: Sector
description: Sector for sector-level fallback
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Get Iv Crush Estimate Api Options Symbol Iv Crush Estimate Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/options/admin/capture-pre-earnings-iv:
post:
tags:
- Options
summary: Trigger Pre Earnings Capture
description: 'Admin: scan screener_cache for tickers with earnings 1-5 days out and record pre-earnings IV.
This runs automatically via the daily cron job but can be triggered manually.'
operationId: trigger_pre_earnings_capture_api_options_admin_capture_pre_earnings_iv_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Trigger Pre Earnings Capture Api Options Admin Capture Pre Earnings Iv Post
security:
- HTTPBearer: []
/api/options/admin/capture-post-earnings-iv:
post:
tags:
- Options
summary: Trigger Post Earnings Capture
description: 'Admin: fill in post-earnings IV for any rows where earnings_date was 1-2 days ago.
Runs automatically via daily cron but can be triggered manually.'
operationId: trigger_post_earnings_capture_api_options_admin_capture_post_earnings_iv_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Trigger Post Earnings Capture Api Options Admin Capture Post Earnings Iv Post
security:
- HTTPBearer: []
/api/options/admin/iv-snapshot:
post:
tags:
- Options
summary: Trigger Iv Snapshot
description: 'Admin: fetch today''s IV rank for all screener tickers from Barchart and store in iv_daily_snapshot.
Runs automatically at market close via daily cron.'
operationId: trigger_iv_snapshot_api_options_admin_iv_snapshot_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Trigger Iv Snapshot Api Options Admin Iv Snapshot Post
security:
- HTTPBearer: []
/api/options/admin/iv-backfill:
post:
tags:
- Options
summary: Trigger Iv Backfill
description: 'Admin: backfill up to 365 days of historical IV rank from Barchart getEquityOptionsOverviewHistory.
One-time operation — safe to re-run (upserts on ticker+date).
Long-running: may take several minutes for a full screener universe.'
operationId: trigger_iv_backfill_api_options_admin_iv_backfill_post
security:
- HTTPBearer: []
parameters:
- name: days
in: query
required: false
schema:
type: integer
maximum: 365
minimum: 1
description: Number of calendar days to backfill
default: 365
title: Days
description: Number of calendar days to backfill
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Trigger Iv Backfill Api Options Admin Iv Backfill Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- openapi.json
- equity-rank-com-openapi.yml