Skip to main content
GET
Policy documents

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Path Parameters

iso
string
required

ISO 3166-1 alpha-2 country code (e.g. US).

Query Parameters

group
string

Document group: overview, decisions, statements, press-conferences, minutes, speeches, beige-book (Fed); base-rate-decisions, press-releases, public-statements, financial-stability, annual-reports, periodic-reports, research (CBUAE). Others are a 400.

docType
string

Document type: fomc_statement, fomc_minutes, fomc_press_conference, fed_speech, beige_book, cbuae_base_rate_decision, cbuae_press_release, cbuae_public_statement, cbuae_financial_stability_report, cbuae_annual_report, cbuae_periodic_report, cbuae_research_paper. Others are a 400.

year
integer

Calendar year, 1900–2100; any other value is a 400.

Required range: 1900 <= x <= 2100
speaker
string

Speaker name, exactly as stored (the page's picker).

speakerWords
string

Words of the speaker's name, any order (e.g. Powell).

district
string

Beige Book district.

Words in the title or speaker line only.

text
string

Words in the documents' own text. Reads the newest documents passing the other filters, within a per-request budget, and answers { items (each with matchedIn, occurrences, snippets), scan: { candidates, offset, scanned, nextOffset, newest, oldest, unreadable, stoppedAtLimit } }; pass scan.nextOffset as offset to search older documents.

analyzedOnly
enum<string>

1 = only documents with extracted observations.

Available options:
1
limit
integer

Default 50, max 200; with text, default 20, max 50. Above the max is a 400.

Required range: 1 <= x <= 200
offset
integer
default:0

Default 0. The list answers limit, offset, hasMore and nextOffset; a text scan answers scan.nextOffset.

Required range: x >= 0
subtype
string

Only documents of this subtype, as listed on each document (subtype).

Response

OK

Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.

items
object[]
total
integer
facets
object
limit
integer
offset
integer
hasMore
boolean
nextOffset
integer