/advan/cities

POST /api/advan/cities

Price: 1 credit

Get a US city's Advan Research mobility page: net resident migration, the top origin and destination states, and the foot-traffic, work-from-home and migration chart images

How to use it

Pass the alias from advan/cities/search. net_migration_count is positive when more residents moved in than out in migration_year. The foot-traffic and work-from-home trends are only published as chart images, so they come back as image links rather than numbers.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — City alias or its Advan Research city page URL (examples: "chicago-il", "https://advanresearch.com/city-location-data/port-st--lucie-fl"; minLength: 1)

Response

• @type string (default: "AdvanCity")
• alias string required
• name string required
• city string nullable
• state string nullable
• url string required
• net_migration_count integer nullable
• top_origin_state string nullable
• top_destination_state string nullable
• migration_year integer nullable
• foot_traffic_chart string nullable
• work_from_home_chart string nullable
• migration_in_map string nullable
• net_migration_map string nullable
• migration_counts_chart string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Advan Research has no page for this city Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.