list_providers
List every available provider, or search the top 5 by keyword.
string
Optional keyword. Omit to list every provider. With a keyword, returns the top 5 matches scored across slug, name, and description.
“Which providers cover Latin American economic data?”Underlying endpoints:
GET /providers (no query) or GET /providers/match?q=... (with query).
get_provider
Get full metadata for one provider, including its tunable parameters and curated popular series.
string
required
Provider slug. Examples:
fred, bls, worldbank, bcra, inegi, banxico, oecd, imf, bis, bcb-opendata.parameters (tunable knobs like FRED’s units or frequency), popular_series, key requirements, and the browse_root_label for hierarchical navigation.
Example prompt
“Tell me about the FRED provider — does it require a key?”Underlying endpoint:
GET /providers/{slug}.
browse_provider
Walk a provider’s hierarchical catalog by path. Only available for providers with the hierarchical capability.
string
required
Provider slug.
string
Slash-separated path inside the provider’s tree. Omit to start at the root.
number
default:"1"
How many levels of children to return in one call. Maximum is 3.
boolean
When
true, return paginated series at the current path instead of subfolders.number
Page size when
series=true.number
Pagination offset when
series=true.“Browse the World Bank Economy & Growth category two levels deep.”Underlying endpoint:
GET /providers/{slug}/browse.
search_provider
Search series within a single provider by keyword. Only for providers with the search capability.
string
required
Provider slug.
string
required
Search query.
number
Maximum number of results.
“Search FRED for unemployment rate series and return the top 10.”Underlying endpoint:
GET /providers/{slug}/search.
get_series
Fetch the full historical data of one provider series.
string
required
Provider slug.
string
required
The provider’s series identifier. Format varies:
UNRATE for FRED, CUUR0000SA0 for BLS, NY.GDP.PCAP.CD for World Bank.object
Provider-specific parameters (FRED
units, BLS startyear, etc.). See get_provider for valid keys.“Fetch the full FRED CPIAUCSL series as year-over-year percent change.”Underlying endpoint:
POST /providers/{slug}/series/{series_id}/data.
Managing provider API keys
Third-party API keys (FRED, BLS, INEGI, Banxico, BEA, EIA, BCCH, and others) are managed through the Alphacast settings page. Once saved, every call to
get_series for that provider uses the key automatically.