> ## Documentation Index > Fetch the complete documentation index at: https://doc.astreus.ai/llms.txt > Use this file to discover all available pages before exploring further. # Country dashboard > Country macro dashboard: every curated indicator for the country as a card — label, units, latest value, change on the prior print, and a short sparkline (the newest 12 current-vintage observations). This is deliberately a summary: a country can carry 900+ series, so the full, uncapped point-in-time history of any one of them is served by GET /api/v1/countries/{iso}/series?key=. ## OpenAPI ````yaml /openapi.json get /api/v1/countries/{iso} openapi: 3.1.0 info: title: Astreus API version: 1.0.0 description: >- Astreus is a financial data terminal that turns the world's unstructured financial disclosure into structured, traceable data. It reads what companies, exchanges and central banks publish — annual and interim reports, SEC filings, results announcements, investor presentations, earnings calls, 8-Ks, regulator notices and policy text — across the United States, the Gulf (Tadawul, DFM, ADX, Boursa Kuwait, QSE), Japan, Taiwan, Korea, the UK and Europe, and serves it as data a program can trust: standardized financial statements (annual, quarterly, semiannual), segments and KPIs, the tables inside the notes, filing sections as text, investor decks page by page, earnings-call transcripts and audio, span-anchored observations, management guidance scored against outcomes, typed 8-K events, an attributed intraday news tape, insider and 13F ownership, a people registry, point-in-time macro series and central-bank text, benchmark, commodity and compute-price series, and a validated causal claim graph with scenario simulation. Every number carries the filing, page or passage it came from (`fact-source`), and nothing is served until it passes per-company validation gates. Coverage is published live: `GET /api/v1/landing/coverage` (no key) returns every market served with company counts, history depth, completeness and periods held per data type — ask it before answering "what do you cover?". `{id}` is a ticker, a numeric SEC CIK, or a platform key for a non-SEC issuer (XSAU000001) — the `cik` field of the company payload. Human-readable guides: https://doc.astreus.ai (coverage at /coverage, data catalog at /data-catalog). Tiers: `public` endpoints need no credentials. Everything else takes an **API key** — create one on the Developers page in the terminal (https://astreus.ai/developers) and send it as `X-API-KEY: pk_live_...` (or `Authorization: Bearer pk_live_...`). Signed-in terminal sessions may use their Cognito ID token instead. Rate limits and quotas are per plan (fixed UTC windows): Free — 30 req/min, 250 req/day; Build — 300 req/min, 100,000 req/month; Scale — custom. Build, Scale and prepaid credits are set up with sales (https://astreus.ai/contact), not self-serve. Responses carry RateLimit-*, X-Quota-* and, when credits pay, X-Billing-Source/X-Credits-Remaining-USD headers; a 429 carries `Retry-After` and a machine `code` of rate_limited or quota_exceeded (with sales_email). Not investment advice. See /terms. contact: email: saif@astreus.ai termsOfService: https://astreus.ai/terms servers: - url: https://astreus.ai security: [] tags: - name: Search & Meta description: Entity resolution and platform metadata. - name: Company Data description: Profiles, structure, leadership, calendars. - name: Financial Statements description: >- Standardized XBRL-derived statements — every line traceable to its filing via fact provenance. - name: SEC Filings description: >- The filing index and documents (SEC and exchange-published), parsed section text, and the tables inside the notes as gated grids and series. - name: 8-K Events description: Material events, typed by family, with extracted item text. - name: News description: >- The intraday news tape: filings, releases and licensed wires with source attribution, storylines and topics. - name: Transcripts & Calls description: Earnings-call transcripts, span-anchored observations, IR decks. - name: Guidance & Scorecards description: What management promised vs. what happened. - name: Ownership & Insiders description: 13F holders, Forms 3/4/5, the people registry. - name: Macro description: Point-in-time economic series and central-bank text. - name: Market Data description: Daily bars for stocks, benchmarks, commodities and compute. - name: Intelligence description: Narratives, the validated claim graph, scenario simulation. - name: Analytics description: Correlation and charting over any catalog series. paths: /api/v1/countries/{iso}: get: tags: - Macro summary: Country dashboard description: >- Country macro dashboard: every curated indicator for the country as a card — label, units, latest value, change on the prior print, and a short sparkline (the newest 12 current-vintage observations). This is deliberately a summary: a country can carry 900+ series, so the full, uncapped point-in-time history of any one of them is served by GET /api/v1/countries/{iso}/series?key=. operationId: get-country-dashboard parameters: - name: iso in: path required: true description: ISO 3166-1 alpha-2 country code (e.g. US). schema: type: string responses: '200': description: OK content: application/json: schema: type: object additionalProperties: true example: country: iso2: US iso3: USA name: United States officialName: null region: Americas subregion: North America capital: null governmentType: null headOfState: null headOfGovernment: null riskScore: null headline: population: null gdpUsdBn: 32475.21 gdpGrowth: null inflation: null unemployment: 4.1 policyRate: 3.63 debtToGdp: null currencyCode: USD currentAccountPctGdp: null ratings: [] indices: [] fx: [] commodities: [] mostActive: [] macroSeries: - key: ADP_PAYROLLS label: ADP Private Payroll Employment unit: Thousands of Persons category: labor latest: 132653000 yoyChange: 29000 history: - period: '2024-03-02' value: 131183000 - period: '2024-03-09' value: 131153000 - key: AVG_HOURLY_EARNINGS label: Avg Hourly Earnings, Production & Nonsup. unit: $ per Hour category: labor latest: 32.4 yoyChange: 0.03999999999999915 history: - period: '2016-08-01' value: 21.6 - period: '2016-09-01' value: 21.62 - key: AVG_WEEKLY_HOURS label: Average Weekly Hours, Total Private unit: Hours category: labor latest: 34.3 yoyChange: 0 history: - period: '2016-08-01' value: 34.3 - period: '2016-09-01' value: 34.4 yieldCurve: - tenorMonths: 3 tenorLabel: 3M yield: 3.87 - tenorMonths: 24 tenorLabel: 2Y yield: 4.19 - tenorMonths: 60 tenorLabel: 5Y yield: 4.39 upcomingAuctions: [] leaders: [] legislature: null elections: [] freedomScore: null corruptionIndex: null relations: [] sanctionsImposed: [] sanctionsAgainst: [] topTradePartners: [] treaties: [] resources: [] energyMix: [] foodSelfSufficiency: null waterStressIndex: null military: null news: [] '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Unknown company, country, symbol or resource. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limited. Honour Retry-After. content: application/json: schema: $ref: '#/components/schemas/Error' security: - apiKey: [] - cognitoIdToken: [] components: schemas: Error: type: object required: - error properties: error: type: string description: Human-readable message. code: type: string description: >- Stable machine code when present: unauthenticated, upgrade_required, rate_limited, quota_exceeded. enum: - unauthenticated - upgrade_required - rate_limited - quota_exceeded securitySchemes: apiKey: type: apiKey in: header name: X-API-KEY description: >- Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as `Authorization: Bearer pk_live_...`. x-default: pk_live_YOUR_KEY cognitoIdToken: type: http scheme: bearer bearerFormat: JWT description: >- Amazon Cognito ID token (token_use=id) for the Astreus user pool — the terminal's own session credential. API consumers should use an API key instead. ````