/costar/articles/search

POST /api/costar/articles/search

Price: 20 credits

Search CoStar News articles across the full commercial real estate archive. Filter by free-text keyword, country, CoStar metropolitan market, property type (office, retail, industrial, hospitality, multifamily, land, healthcare, mixed use, specialty), deal type (lease or sale), editorial topic, covered company and publication date range. Results are newest first and carry the article id, URL, headline, teaser, lead image with caption and publication time.

How to use it

Find CoStar News articles about commercial real estate. Combine keyword with country, market, property_type, transaction_type, topic, company and a date_from/date_to window to slice the archive, and set count to how many articles to return. Feed the returned id into costar/articles to get the full record including the properties, companies and people the story is about.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Free-text query over headlines, addresses, places, people and companies (minLength: 1)
• country string — Country the covered real estate is located in (default: "USA"; one of: "USA", "FRA", "GBR", "CAN", "DEU", "CHN", "ESP", "NLD", "IND", "MEX", "SGP", "ITA", "AUS", "IRL", "JPN", "ARE", "HKG", "BRA", "RUS", "SAU", "THA", "GEO", "COL", "TUR", "IDN", "EGY", "ZAF", "GRC", "PRT", "AUT", "CHE", "QAT", "SWE", "POL", "NZL", "ARG", "VNM", "MYS", "PRI", "KOR", "CHL", "PAN", "DNK", "PER", "BEL", "BHS", "CUB", "ISR", "OMN", "MDV", "PHL", "JOR", "MAC", "MAR", "CRI", "FIN", "NGA", "NOR", "HUN", "KEN", "TWN", "TCD", "JAM", "BHR", "UKR", "IRN", "LKA", "KWT", "HRV", "NAM", "TZA", "LBN", "CZE", "MUS", "ECU", "ISL", "TUN", "MMR", "ETH", "IRQ", "MCO", "BMU", "LTU", "ROU", "URY", "SYR", "ABW", "KHM", "DOM", "EST", "RWA", "LUX", "DZA", "KAZ", "BRB", "SVK", "CYP", "AZE", "LBY", "VEN", "BGR", "HTI", "FJI", "MLT", "GHA", "AGO", "MOZ", "AIA", "LVA", "CYM", "PAK", "VIR", "SYC", "PRY", "NIC", "ZMB", "MNE", "GIN", "COG", "MNG", "SEN", "SOM", "PRK", "PYF", "BLZ", "UGA", "CUW", "CPV", "DMA", "LAO", "VGB", "BGD", "BTN", "SLV", "SRB", "BWA", "HND", "BRN", "UZB", "BLR", "TJK", "NPL", "ZWE", "AFG", "TTO", "REU", "BOL", "GTM", "SDN", "COD", "SVN", "CIV", "BES", "BIH", "GRL", "GUM", "KGZ", "MLI", "SSD", "SLE", "TKM", "ARM", "GRD", "NER", "ALB", "GAB", "MWI", "COM", "LBR", "AND", "BEN", "TGO", "CMR", "GNQ", "PNG", "GUY", "MRT", "BDI", "ATG", "GIB", "PLW", "LCA", "MDG", "MTQ", "CHA", "DJI", "GLP", "GMB", "NCL", "PSE", "TCA", "MDA", "TON", "SXM", "VAT", "IMN", "KIR", "KNA", "MHL", "MSR", "NIU", "STP", "SUR", "TUV", "LSO")
• market array nullable — CoStar metropolitan markets, prefixed by country (usa-, gbr-, can-, fra-, deu-, esp-, aus-) (one of: "usa-albany-schenectady-troy", "usa-albuquerque", "usa-atlanta", "usa-augusta-richmond-county", "usa-austin", "usa-bakersfield", "usa-baltimore", "usa-baton-rouge", "usa-beaumont-port-arthur", "usa-birmingham", "usa-boise-city-nampa", "usa-boston", "usa-brownsville-harlingen", "usa-buffalo-niagara-falls", "usa-charleston-n-charleston", "usa-charlotte", "usa-chattanooga", "usa-chicago", "usa-cincinnati-dayton", "usa-cleveland", "usa-colorado-springs", "usa-columbia", "usa-columbus", "usa-corpus-christi", "usa-dallas-ft-worth", "usa-davenport-moline-rock-island", "usa-deltona-daytona-beach", "usa-denver", "usa-des-moines", "usa-detroit", "usa-duluth", "usa-east-bay-oakland", "usa-el-paso", "usa-evansville", "usa-fayetteville", "usa-fayetteville-northwest-arkansas", "usa-fort-smith", "usa-fort-wayne", "usa-fresno", "usa-green-bay", "usa-greensboro-winston-salem", "usa-greenville-spartanburg", "usa-hampton-roads", "usa-hartford", "usa-hawaii", "usa-houston", "usa-huntsville", "usa-indianapolis", "usa-inland-empire-california", "usa-jackson", "usa-jacksonville-florida", "usa-kansas-city", "usa-killeen-temple-fort-hood", "usa-kingsport-bristol-bristol", "usa-knoxville", "usa-lafayette", "usa-las-vegas", "usa-lexington-fayette", "usa-lincoln", "usa-little-rock-n-little-rock", "usa-long-island-new-york", "usa-los-angeles", "usa-louisville", "usa-lubbock", "usa-mcallen-edinburg-pharr", "usa-memphis", "usa-milwaukee-madison", "usa-minneapolis-st-paul", "usa-mobile", "usa-montgomery", "usa-myrtle-beach-conway", "usa-nashville", "usa-new-orleans-metairie-kenner", "usa-new-york-city", "usa-north-bay-santa-rosa", "usa-northern-new-jersey", "usa-ocala", "usa-oklahoma-city", "usa-olympia", "usa-omaha-council-bluffs", "usa-orange-county-california", "usa-orlando", "usa-pensacola", "usa-philadelphia", "usa-phoenix", "usa-pittsburgh", "usa-port-st-lucie-fort-pierce", "usa-portland", "usa-providence", "usa-raleigh-durham", "usa-reno-sparks", "usa-richmond-va", "usa-roanoke", "usa-rochester", "usa-sacramento", "usa-salinas", "usa-salt-lake-city", "usa-san-antonio", "usa-san-diego", "usa-san-francisco", "usa-san-luis-obispo-paso-robles", "usa-santa-cruz-watsonville", "usa-savannah", "usa-seattle-puget-sound", "usa-shreveport-bossier-city", "usa-south-bay-san-jose", "usa-south-bend-mishawaka", "usa-south-florida", "usa-southwest-florida", "usa-spokane", "usa-springfield", "usa-st-louis", "usa-stockton-modesto", "usa-syracuse", "usa-tallahassee", "usa-tampa-st-petersburg", "usa-toledo", "usa-tucson", "usa-tulsa", "usa-utica-rome", "usa-washington-dc", "usa-west-michigan", "usa-westchester-so-connecticut", "usa-wichita", "usa-wilmington", "usa-youngstown-warren-boardman", "fra-auvergne-rhone-alps", "fra-bordeaux", "fra-bourgogne-franche-comte", "fra-brittany-and-normandy", "fra-corsica-provence-alpes-cda", "fra-grand-est", "fra-ile-de-france", "fra-lille", "fra-lyon", "fra-marseille-aix-en-provence", "fra-nantes", "fra-nice", "fra-nouvelle-aquitaine", "fra-paris", "fra-toulouse", "gbr-aberdeen", "gbr-berkshire-and-north-hampshire", "gbr-birmingham", "gbr-brighton", "gbr-bristol", "gbr-buckinghamshire", "gbr-cambridge", "gbr-cardiff", "gbr-central-scotland", "gbr-channel-islands", "gbr-cheltenham-and-gloucester", "gbr-cheshire-south", "gbr-coventry", "gbr-cumbria", "gbr-derby", "gbr-devon-and-cornwall", "gbr-edinburgh", "gbr-essex", "gbr-gatwick", "gbr-glasgow", "gbr-hampshire", "gbr-herefordshire-and-worcestershire", "gbr-hertfordshire", "gbr-highlands-and-islands", "gbr-hull", "gbr-isle-of-man", "gbr-kent", "gbr-lancashire", "gbr-leeds", "gbr-leicester", "gbr-lincoln", "gbr-liverpool", "gbr-london", "gbr-luton-and-bedfordshire", "gbr-manchester", "gbr-milton-keynes", "gbr-newcastle-upon-tyne", "gbr-north-wales", "gbr-northampton", "gbr-northern-ireland", "gbr-norwich", "gbr-nottingham", "gbr-oxford", "gbr-peterborough", "gbr-sheffield", "gbr-shropshire-and-staffordshire", "gbr-somerset", "gbr-south-coast", "gbr-southern-scotland", "gbr-suffolk", "gbr-surrey", "gbr-sussex-east", "gbr-swansea", "gbr-swindon", "gbr-tees-valley-and-durham", "gbr-warrington", "gbr-york", "can-greater-calgary", "can-greater-edmonton", "can-greater-montr-al", "can-greater-ottawa", "can-greater-toronto", "can-greater-vancouver", "can-outer-greater-toronto-area", "deu-balticcoast", "deu-berlin", "deu-cologne", "deu-dusseldorf", "deu-east-germany", "deu-frankfurt-rhine-main", "deu-hamburg", "deu-leipzig", "deu-munich", "deu-north-germany", "deu-ruhr", "deu-south-germany", "deu-stuttgart", "deu-west-germany", "esp-andalusia", "esp-balearic-islands", "esp-barcelona", "esp-canary-islands", "esp-castille-leon-clm-extremadura", "esp-madrid", "esp-spain-northwest", "aus-adelaide", "aus-brisbane", "aus-canberra", "aus-darwin", "aus-hobart", "aus-melbourne", "aus-other-territories", "aus-outlying-new-south-wales", "aus-outlying-northern-territory", "aus-outlying-queensland", "aus-perth", "aus-sydney")
• property_type array nullable — Property types covered (one of: "office", "retail", "industrial", "hospitality", "multifamily", "land", "healthcare", "mixed-use", "specialty")
• transaction_type array nullable — Deal types covered (one of: "lease", "sale")
• topic array nullable — Editorial topics (one of: "analytics", "companies", "coworking", "design-and-construction", "development", "economy", "environmental", "finance", "legal-legislation", "operations", "opinions", "people", "power-brokers", "public-sector", "reit", "technology", "video")
• company string nullable — CoStar company key, as returned in the companies block of an article (examples: "9jlxvc4"; minLength: 1)
• date_from string nullable — Earliest publication date, YYYY-MM-DD (examples: "2026-01-01")
• date_to string nullable — Latest publication date, YYYY-MM-DD (examples: "2026-02-01")
• count integer required — Max number of articles to return (min: 1)

Response

• @type string (default: "CostarArticleCard")
• id string required
• alias string nullable
• url string required
• article_title string nullable
• summary string nullable
• image string nullable
• image_caption string nullable
• badge string nullable
• published_at integer 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 — The entity was not found, or a precondition failed 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.