Getting started
Quickstart
Your first screen, in 60 seconds.
First calls
Three requests that build on each other: a screen, the same screen on a past date and one ticker in depth. Every example uses YOUR_KEY; get one on the Authentication page.
Run a screen: cheap and growing large caps
curl -X POST "https://api.tickerbot.io/v2/scan" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "pe_ratio < 15 AND earnings_growth_yoy_pct > 15 AND market_cap > 1e9"
}'Backtest it: the same screen at the March 2020 COVID low, with no look-ahead and delisted names included
curl -X POST "https://api.tickerbot.io/v2/scan" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "pe_ratio < 15 AND earnings_growth_yoy_pct > 15 AND market_cap > 1e9",
"asof": "2020-03-23"
}'Drill down: everything about one ticker
curl "https://api.tickerbot.io/v2/tickers/NVDA" \
-H "Authorization: Bearer YOUR_KEY"Any ticker goes in the path, like one from your results.