Area resolve
POST /v1/areas/resolveResolve an area name or code ("Hackney", "E5") to its area_id, centroid
Same call over MCP
Resolve an area namearea_resolveAuthenticate with an API key from the API & MCP Hub. The same call is available as an MCP tool at the same price.
Request
Calling POST /v1/areas/resolve
curl -X POST "https://api.marketcode.ai/v1/areas/resolve" \
-H "Authorization: Bearer $MARKETCODE_API_KEY"
-H "Content-Type: application/json" \
-d '{"area_name":"Lewisham"}'Send your API key as a Bearer token. Every response carries credits_charged and credits_remaining.
Inputs
Parameters
This endpoint takes no path or query parameters.
Request body
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| area_name | Body | string | Yes | Area name or code, e.g. "Hackney", "Kensington", "E5" |
| include_h3 | Body | boolean | No | Also return H3 cell IDsDefault: false |
| h3_resolution | Body | integer | No | H3 resolution 7-10Default: 9 |
Response
What POST /v1/areas/resolve returns for a real request
curl -X POST "https://api.marketcode.ai/v1/areas/resolve" \
-H "Authorization: Bearer $MARKETCODE_API_KEY"
-H "Content-Type: application/json" \
-d '{"area_name":"Lewisham"}'{
"country": "UK",
"query": {
"area_name": "Lewisham",
"include_h3": false,
"h3_resolution": 9
},
"data": {
"area_id": "e7eb27fb-677c-4b58-b9ba-414769855966",
"analytics_area_id": "c0694b59-04d1-48ab-9a4c-c4f9d7b74f60",
"analytics_available": true,
"analytics_note": null,
"area_name": "Lewisham",
"area_type_id": "3977a3cf-ccdb-4be4-90ec-ad43cacb0b42",
"area_type_name": "London Borough",
"breadcrumbs": [
{
"area_id": "e7eb27fb-677c-4b58-b9ba-414769855966",
"analytics_area_id": "c0694b59-04d1-48ab-9a4c-c4f9d7b74f60",
"area_name": "Lewisham",
"area_type_id": "3977a3cf-ccdb-4be4-90ec-ad43cacb0b42",
"area_type_name": "London Borough"
},
{
"area_id": "b85bfb60-ebbe-4037-9c98-aea6cc99408c",
"analytics_area_id": "98da0473-1a60-4f0f-925d-99a979cbb1ed",
"area_name": "se13",
"area_type_id": "7343747e-81f5-4b34-981d-fe5bfc384bae",
"area_type_name": "Postcode District"
},
{
"area_id": "7daf45e6-a0c3-4a72-b148-ceffe47e1167",
"analytics_area_id": "e8476683-6bde-44f0-984e-185129440efd",
"area_name": "Greater London Authority",
"area_type_id": "958afa36-97ab-4ae4-9317-a52147c35eac",
"area_type_name": "Greater London Authority"
},
"… 1 more"
],
"centroid_lat": 51.448271648502384,
"centroid_lng": -0.020264822913990323,
"h3_ids": null,
"h3_resolution": null
},
"credits_charged": 0
}A real response, captured from production and trimmed: arrays to three items, long strings shortened, volatile keys dropped.
Response
Response fields
| Field | Type | Example |
|---|---|---|
| country | string | UK |
| query | object | |
| query.area_name | string | Lewisham |
| query.include_h3 | boolean | false |
| query.h3_resolution | integer | 9 |
| data | object | |
| data.area_id | string | e7eb27fb-677c-4b58-b9ba-414769855966 |
| data.analytics_area_id | string | c0694b59-04d1-48ab-9a4c-c4f9d7b74f60 |
| data.analytics_available | boolean | true |
| data.analytics_note | null | |
| data.area_name | string | Lewisham |
| data.area_type_id | string | 3977a3cf-ccdb-4be4-90ec-ad43cacb0b42 |
| data.area_type_name | string | London Borough |
| data.breadcrumbs | array | |
| data.breadcrumbs[].area_id | string | e7eb27fb-677c-4b58-b9ba-414769855966 |
| data.breadcrumbs[].analytics_area_id | string | c0694b59-04d1-48ab-9a4c-c4f9d7b74f60 |
| data.breadcrumbs[].area_name | string | Lewisham |
| data.breadcrumbs[].area_type_id | string | 3977a3cf-ccdb-4be4-90ec-ad43cacb0b42 |
| data.breadcrumbs[].area_type_name | string | London Borough |
| data.centroid_lat | number | 51.448271648502384 |
| data.centroid_lng | number | -0.020264822913990323 |
| data.h3_ids | null | |
| data.h3_resolution | null | |
| credits_charged | integer | 0 |
Fields observed in the example response above; a field the example did not exercise is not listed.
Price and licence
What it costs, and where the data comes from
Area resolve is free over MCP and over REST, and the two surfaces share one credit balance. Free calls need a signed-in account or an API key and appear in your usage, but they never touch your balance.
Credits are granted on sign-up and bought in packs; the pricing page lists every call.
Sources
- Office for National Statistics
Price Index of Private Rents and geography lookups
Open Government Licence v3 · UK
Related
Endpoints used with Area resolve
- Market facts for an areaFree
market_factsPrice, rent, yield and days-on-market by geography × asset class ×Same product - Rank areas on a market metricFree
market_rankingRank areas against each other on a market metric — one row per area at the latest period. Defaults to turnover_rate, which is sales as a share of the stock that could have sold: the liquidity measure, as opposed to transaction count, which measures market size.Same product - House price index seriesFree
market_index_seriesThe published house-price INDEX for one postcode district or local authority: the level per month (base period = 100), the forecast tail flagged, and provenance saying how the index was built.Same product - Asking-price index (portal listings)Free
asking_price_index_seriesHedonic ASKING-PRICE index for one postcode district, local authority or Great Britain, from portal listings (Rightmove ~95%), 2022M01 = 100, with 80% bands and posterior standard errors, smoothed toward the parent geography.Same product - Monthly transaction volumeFree
market_volume_seriesMonthly transaction VOLUME for a postcode district, postcode area orSame product - Live listings stock, dailyFree
listing_stock_seriesLive listings on the market by day for one area, channel and bedroom band — the stock-on-market series, with the median age of the dated live stock, median asking price or rent, and the new-build count.Same product
Glossary
Terms used here
- GSS code: The nine-character statistical code the ONS gives every UK administrative area; MarketCode accepts names in most places and bridges them to codes internally.
- H3 cell: A hexagon in the H3 global grid; MarketCode uses resolution-8 cells (about 0.7 km² each) for map density layers and as the spatial unit inside the valuation model.
FAQ
Questions about Area resolve
How much does `area_resolve` cost?
+
Area resolve is free over MCP and over REST, and the two surfaces share one credit balance. Free calls need a signed-in account or an API key and appear in your usage, but they never touch your balance.
How do I authenticate?
+
Send your API key as a Bearer token in the Authorization header. Keys are created in the API & MCP Hub, shown once and revocable. Every response carries the credits charged and your remaining balance.
Is there an MCP version?
+
Yes. The area_resolve tool on the MarketCode MCP server is the same call at the same price, signed in with OAuth rather than a key, so Claude, ChatGPT, Codex and Cursor can run it in a conversation.
Where does the data come from?
+
Read from Office for National Statistics price index of private rents and geography lookups. Coverage is the UK.
Does `area_resolve` change anything?
+
No. The tool is annotated read-only on the server, so it never writes to your data or ours and an assistant can call it without a confirmation step.
Try Area resolve on a real address.
30-minute call. We'll provision a key and walk through the endpoint on your use case.