/advan/cmbs_deals

POST /api/advan/cmbs_deals

Price: 1 credit

Get a CMBS deal's Advan Research foot-traffic page: the largest loan's address, the most visited properties with their addresses, and the deal and loan chart images

How to use it

Pass the deal name as written, such as BACM 2000-2, or the alias from advan/cmbs_deals/search. top_properties lists the deal's up to three most visited properties. Foot traffic is only published as chart images, so it comes 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)
• deal string required — CMBS deal name, its alias, or its Advan Research deal page URL (examples: "BACM 2000-2", "bank-2020-bn26", "https://advanresearch.com/cmbs-foot-traffic/aacmt-2002-c5"; minLength: 1)

Response

• @type string (default: "AdvanCmbsDeal")
• alias string required
• deal string required
• url string required
• largest_loan_address string nullable
• top_properties array (default: [])
  • @type string (default: "AdvanProperty")
  • name string nullable
  • address string nullable
• deal_traffic_chart string nullable
• largest_loan_traffic_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 deal 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.