Profile of a place
An overview of one place in a single call: its latest official figures grouped in sections (people, work and income, economy, prices and housing, consumers, business and tourism, health, digital, energy and environment), each with its period, its change from a year earlier, its rank among similar places and its source, plus a one-sentence summary per section. Use it for "give me an overview of Travis County", "key statistics for Bavaria", "a profile of Mataró". For one figure use get_value; for a ranking use rank_places. Only sections the place has data for are returned, with at most 6 figures each. sections limits the answer to some of them: people, work_income, economy, prices_housing, consumers, business, health, digital, environment. Example: {"place": "Travis County, Texas"}. {"place": "Spain", "sections": ["economy", "work_income"]}. Returns {place, url, sections: [{id, title, summary, figures: [{indicator, value, text, period, status?, change?: {kind, value, unit, from_period, from_value}, change_note?, rank?: {rank, counted_from, of, tied, period, among, ranking_url}, source}]}], sources: [{id, name, publisher, title, url, retrieved, license, citation}], notes}. change.kind is percent, points (percentage points), difference or compare (a net balance, given with the earlier value). rank counts from the nearer end: {rank: 3, counted_from: "lowest"} is the 3rd lowest. Each figure names its source by id; cite sources[].citation and give the period. One call, whatever the number of figures.
Request
- Base URL: https://invokely.ai
- URL: https://invokely.ai/api/v1/profile
- Auth: one of:
- HTTP bearer
- API key in header x-api-key
- none
Query parameters
Place name or id, for example Mataró, Texas, Japan, "Austin, TX", es-mun-08121, ES51 (NUTS), fips:48453 (US county) or fips:4805000 (US city).
ISO 3166-1 alpha-2 code that disambiguates the place, for example ES or US.
Sections to return, repeated (section=economy§ion=health) or as sections=economy|health. All by default.
Response
Success. The body is {"data": ...}; the remaining allowance is in the x-invokely-remaining header.
Changes
No recorded changes to this operation across all 1 revision of this API.