/costar/articles

POST /api/costar/articles

Price: 10 credits

Get a single CoStar News article by id or URL. Returns the headline, summary, publication time, lead image with caption, bylined authors, category taxonomy and the article text. The most valuable part is the entity linkage CoStar attaches to each story: the commercial properties (name and street address), companies (name and industry), people (name, job title, company) and investment funds the article is about. Note that for most stories text carries the opening paragraph only — is_full_text tells you whether the complete body was published openly.

How to use it

Look up one CoStar News article. Pass article as the numeric id or the full costar.com/article/... URL. Use properties, companies, contacts and funds to map a news story onto concrete commercial real estate assets, firms and executives. is_full_text is false when only the opening paragraph of text is public.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• article string required — CoStar article id or full article URL (examples: "1347506854", "https://www.costar.com/article/1347506854/mars-becomes-latest-company"; minLength: 1)

Response

• @type string (default: "CostarArticle")
• id string required
• alias string nullable
• url string required
• article_title string nullable
• summary string nullable
• text string nullable
• is_full_text boolean (default: false)
• published_at integer nullable
• image string nullable
• image_caption string nullable
• badge string nullable
• template_type string nullable
• source_locale string nullable
• translation_type string nullable
• countries array (default: [])
• authors array (default: [])
  • @type string (default: "CostarArticleAuthor")
  • id string required
  • name string nullable
  • alias string nullable
  • affiliation string nullable
  • profile_url string nullable
• categories array (default: [])
  • @type string (default: "CostarArticleCategory")
  • id string required
  • name string nullable
  • category_type string nullable
• primary_category object nullable
  • @type string (default: "CostarArticleCategory")
  • id string required
  • name string nullable
  • category_type string nullable
• properties array (default: [])
  • @type string (default: "CostarArticleProperty")
  • id string required
  • name string nullable
  • address string nullable
  • url string nullable
• companies array (default: [])
  • @type string (default: "CostarArticleCompany")
  • key string required
  • name string nullable
  • industry string nullable
  • url string nullable
• contacts array (default: [])
  • @type string (default: "CostarArticleContact")
  • id string required
  • key string nullable
  • name string nullable
  • job_title string nullable
  • company_name string nullable
• funds array (default: [])
  • @type string (default: "CostarArticleFund")
  • id string required
  • key string nullable
  • name string nullable
• related_articles array (default: [])
  • @type string (default: "CostarRelatedArticle")
  • id string required
  • article_title string nullable
  • alias string nullable
  • category string nullable
  • url 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 — Article not found 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.