Alpha AnalystDocs

Time Series Metrics API

Discover chartable series—prices, fundamentals, ratios, dividends—by keyword or category before calling Time Series.

curl -X GET "https://example.com/v2/timeseries/metrics?query=revenue&category=income_statement&limit=3"
{  "query": "revenue",  "category": "income_statement",  "count": 12,  "limit": 3,  "offset": 0,  "categories": [    {      "id": "price_and_volume",      "name": "Price & Volume",      "count": 21    },    {      "id": "income_statement",      "name": "Income Statement",      "count": 165    },    {      "id": "balance_sheet",      "name": "Balance Sheet",      "count": 306    },    {      "id": "cash_flow_statement",      "name": "Cash Flow Statement",      "count": 180    },    {      "id": "financial_ratios",      "name": "Financial Ratios",      "count": 580    },    {      "id": "key_metrics",      "name": "Key Metrics",      "count": 280    },    {      "id": "dividends_and_buybacks",      "name": "Dividends & Buybacks",      "count": 3    }  ],  "metrics": [    {      "id": "costOfRevenue__annual",      "name": "Cost Of Revenue (Annual)",      "category": "income_statement",      "grain": "fiscal"    },    {      "id": "costOfRevenue__quarter",      "name": "Cost Of Revenue (Quarterly)",      "category": "income_statement",      "grain": "fiscal"    },    {      "id": "ttmCostOfRevenue",      "name": "Cost Of Revenue (TTM)",      "category": "income_statement",      "grain": "fiscal_ttm"    }  ]}
GET
/v2/timeseries/metrics

Query Parameters

query?string

Case-insensitive search over series id and name. Combines with category. Omit to skip text search.

Length1 <= length <= 200
category?string

Picker group slug. entity_attributes, entity_info, security_info, price_and_volume, income_statement, balance_sheet, cash_flow_statement, financial_ratios, key_metrics, shares_and_float, dividends_and_buybacks, analyst_estimates, technical, or other. Omit to return every category. Combines with query.

Value in

  • "entity_attributes"
  • "entity_info"
  • "security_info"
  • "price_and_volume"
  • "income_statement"
  • "balance_sheet"
  • "cash_flow_statement"
  • "financial_ratios"
  • "key_metrics"
  • "shares_and_float"
  • "dividends_and_buybacks"
  • "analyst_estimates"
  • "technical"
  • "other"
limit?integer

Page size when query or category is set. Default 20. Maximum 50.

Range1 <= value <= 50
Default20
offset?integer

Number of matching series to skip. Default 0.

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json