Intelligence

Query intelligence

Changed on

Run a query plan or natural-language question against the intelligence moat. Supports rank_areas, get_area, score_area, compare_areas, find_peers, find_insights, and find_forecast. A rank_areas plan on a deprivation signal must set country or lad (deciles and ranks are relative within a nation), otherwise it is rejected with 422, code invalid_signal. Callable without an API key at the anonymous tier's quota (AR-594, Plan 059.2). Natural-language queries on free tiers (anonymous, logged_in, basic) are processed by OpenCode and OpenRouter free models, which may retain prompts for model improvement. Paid tiers and programmatic plan queries do not use these providers.

post/v1/query

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/query
  • Auth: one of:
    • HTTP bearer
    • none

Query parameters

bundlestring

Optional bundle ID to scope available signals.

Request body

OR

Example request

{
  "question": "best areas for families in London"
}

Response

Default Response

planobject required
plan_source'client' | 'nl' required

Changes

  • b318d28b3412Revision changes
    • warning

      added the new nation_not_covered enum value to the / response property for the response status

    • warning

      added the new nation_not_covered enum value to the / response property for the response status

    • warning

      added the new nation_not_covered enum value to the response property for the response status

    • warning

      added the new nation_not_covered enum value to the response property for the response status