{"openapi":"3.1.0","info":{"title":"DuckDuckGo Image & News Search API","summary":"Search images and news, with precise US address matching. Search routes require X-API-Key.","description":"\nSearch DuckDuckGo images with filters for size, color, type, layout, license, region, and time range,\nand search news from Bing, DuckDuckGo, and Yahoo.\n\n## Precise address search\n\nPass `address` (e.g. `265 South Street Manhattan NY 10004`) instead of, or alongside, `query`.\nThe street line is quoted and results that don't mention it (as \"265 South St\" or\n\"265 South Street\") are dropped. The response shows `effective_query`, the parsed\n`address`, and how many results were `filtered_out`.\n\n## NYC project coverage\n\n`/api/project` takes an `address` and/or `project` name (e.g. `Two Bridges`) and searches\nNYC real-estate outlets plus the open web. It reads each article's publish date and lead\nimage, so it finds older coverage (permits, sales, lawsuits) that `/api/news` misses.\n\n## Authentication\n\n1. Click **Authorize**\n2. Paste your API key\n3. Run any `/api/search`, `/api/news`, or `/api/project` request\n\nThe key is sent as `X-API-Key`. Query-string keys are rejected.\n\n`/`, `/health`, and `/api/info` stay public.\n\n## Rate limits\n\n- 30 search requests per minute per IP (images, news, and projects combined)\n- 10 failed authentication attempts per minute per IP\n\n```bash\ncurl -H \"X-API-Key: YOUR_API_KEY\" \\\n  \"http://127.0.0.1:8000/api/search?query=butterfly&max_results=5\"\n```\n    ","contact":{"name":"API access","email":"javier@privatediningpros.com"},"version":"1.0.0"},"paths":{"/":{"get":{"tags":["Info"],"summary":"Homepage","description":"API Homepage - Welcome page with API information and documentation links","operationId":"root__get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/api/info":{"get":{"tags":["Info"],"summary":"API metadata","description":"Public JSON summary of endpoints and example calls.","operationId":"api_info_api_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/search":{"get":{"tags":["Search"],"summary":"Search images","description":"Search images with query parameters. Authorize first so Swagger sends `X-API-Key`.\n\nSend `query`, `address`, or both. For a place, prefer `address`: the street line is\nquoted and, with `strict` on, results that don't mention it are dropped.","operationId":"search_images_get_api_search_get","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search keywords. Wrap words in double quotes to require that exact phrase.","examples":["butterfly","\"265 South Street\" tower"],"title":"Query"},"description":"Search keywords. Wrap words in double quotes to require that exact phrase."},{"name":"address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"US street address, e.g. '265 South Street Manhattan NY 10004'. The street line is quoted and results must mention it. Combine with `query` to add topic words (e.g. query='construction').","examples":["265 South Street Manhattan NY 10004"],"title":"Address"},"description":"US street address, e.g. '265 South Street Manhattan NY 10004'. The street line is quoted and results must mention it. Combine with `query` to add topic words (e.g. query='construction')."},{"name":"strict","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Drop results that do not mention the address or every quoted phrase in the query. Defaults to on when `address` is set, off otherwise.","title":"Strict"},"description":"Drop results that do not mention the address or every quoted phrase in the query. Defaults to on when `address` is set, off otherwise."},{"name":"max_results","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of results to return (1-100)","examples":[10,20,50],"default":10,"title":"Max Results"},"description":"Maximum number of results to return (1-100)"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"Region code: wt-wt (worldwide), us-en (US), uk-en (UK), es-es (Spain), fr-fr (France)","examples":["us-en","uk-en","wt-wt"],"default":"us-en","title":"Region"},"description":"Region code: wt-wt (worldwide), us-en (US), uk-en (UK), es-es (Spain), fr-fr (France)"},{"name":"safesearch","in":"query","required":false,"schema":{"type":"string","description":"Safe search level: off, moderate, on","examples":["off","moderate","on"],"default":"off","title":"Safesearch"},"description":"Safe search level: off, moderate, on"},{"name":"timelimit","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time limit filter: d (day), w (week), m (month), y (year)","examples":["d","w","m","y"],"title":"Timelimit"},"description":"Time limit filter: d (day), w (week), m (month), y (year)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","maximum":10,"minimum":1,"description":"Page number for pagination (1-10)","examples":[1,2,3],"default":1,"title":"Page"},"description":"Page number for pagination (1-10)"},{"name":"backend","in":"query","required":false,"schema":{"type":"string","description":"Backend: auto, bing, duckduckgo. Filters and timelimit force duckduckgo (bing ignores them).","examples":["auto","bing","duckduckgo"],"default":"auto","title":"Backend"},"description":"Backend: auto, bing, duckduckgo. Filters and timelimit force duckduckgo (bing ignores them)."},{"name":"size","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Size filter: Small, Medium, Large, Wallpaper","examples":["Small","Medium","Large","Wallpaper"],"title":"Size"},"description":"Size filter: Small, Medium, Large, Wallpaper"},{"name":"color","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Color filter: Monochrome, Red, Orange, Yellow, Green, Blue, Purple, Pink, Brown, Black, Gray, Teal, White","examples":["Red","Blue","Green"],"title":"Color"},"description":"Color filter: Monochrome, Red, Orange, Yellow, Green, Blue, Purple, Pink, Brown, Black, Gray, Teal, White"},{"name":"type_image","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Type filter: Photo, Clipart, Gif, Transparent, Line","examples":["Photo","Clipart","Gif"],"title":"Type Image"},"description":"Type filter: Photo, Clipart, Gif, Transparent, Line"},{"name":"layout","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Layout filter: Square, Tall, Wide","examples":["Square","Tall","Wide"],"title":"Layout"},"description":"Layout filter: Square, Tall, Wide"},{"name":"license_image","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"License filter: Public, Share, ShareCommercially, Modify, ModifyCommercially","examples":["Public","Share"],"title":"License Image"},"description":"License filter: Public, Share, ShareCommercially, Modify, ModifyCommercially"},{"name":"validate_images","in":"query","required":false,"schema":{"type":"boolean","description":"Validate image URLs (slower but more reliable - checks if images are accessible)","examples":[true,false],"default":false,"title":"Validate Images"},"description":"Validate image URLs (slower but more reliable - checks if images are accessible)"}],"responses":{"200":{"description":"Matching images","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Missing query/address or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"502":{"description":"Upstream search provider error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Search"],"summary":"Search images (JSON)","description":"Same search as GET, with a JSON body. Authorize first so Swagger sends `X-API-Key`.","operationId":"search_images_post_api_search_post","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageSearchRequest"}}}},"responses":{"200":{"description":"Matching images","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Missing query/address or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"502":{"description":"Upstream search provider error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/api/news":{"get":{"tags":["News"],"summary":"Search news","description":"Search news with query parameters. Authorize first so Swagger sends `X-API-Key`.\n\nSend `query`, `address`, or both (e.g. address + query='rezoning').","operationId":"search_news_get_api_news_get","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search keywords. Wrap words in double quotes to require that exact phrase.","examples":["sun","\"265 South Street\""],"title":"Query"},"description":"Search keywords. Wrap words in double quotes to require that exact phrase."},{"name":"address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"US street address, e.g. '265 South Street Manhattan NY 10004'. The street line is quoted and results must mention it. Combine with `query` to add topic words (e.g. query='construction').","examples":["265 South Street Manhattan NY 10004"],"title":"Address"},"description":"US street address, e.g. '265 South Street Manhattan NY 10004'. The street line is quoted and results must mention it. Combine with `query` to add topic words (e.g. query='construction')."},{"name":"strict","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Drop results that do not mention the address or every quoted phrase in the query. Defaults to on when `address` is set, off otherwise.","title":"Strict"},"description":"Drop results that do not mention the address or every quoted phrase in the query. Defaults to on when `address` is set, off otherwise."},{"name":"max_results","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of results (1-100)","default":10,"title":"Max Results"},"description":"Maximum number of results (1-100)"},{"name":"region","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{2}$","description":"Region code, e.g. us-en, uk-en, wt-wt","default":"us-en","title":"Region"},"description":"Region code, e.g. us-en, uk-en, wt-wt"},{"name":"safesearch","in":"query","required":false,"schema":{"enum":["on","moderate","off"],"type":"string","description":"Safe search level: off, moderate, on","default":"off","title":"Safesearch"},"description":"Safe search level: off, moderate, on"},{"name":"timelimit","in":"query","required":false,"schema":{"anyOf":[{"enum":["d","w","m","y"],"type":"string"},{"type":"null"}],"description":"Time limit: d (day), w (week), m (month), y (year)","title":"Timelimit"},"description":"Time limit: d (day), w (week), m (month), y (year)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","maximum":10,"minimum":1,"description":"Page number for pagination (1-10)","default":1,"title":"Page"},"description":"Page number for pagination (1-10)"},{"name":"backend","in":"query","required":false,"schema":{"enum":["auto","bing","duckduckgo","yahoo"],"type":"string","description":"Backend: auto, bing, duckduckgo, yahoo. auto falls back across engines.","default":"auto","title":"Backend"},"description":"Backend: auto, bing, duckduckgo, yahoo. auto falls back across engines."}],"responses":{"200":{"description":"Matching news articles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsResponse"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Missing query/address or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"502":{"description":"Upstream search provider error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["News"],"summary":"Search news (JSON)","description":"Same news search as GET, with a JSON body.","operationId":"search_news_post_api_news_post","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsSearchRequest"}}}},"responses":{"200":{"description":"Matching news articles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsResponse"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Missing query/address or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"502":{"description":"Upstream search provider error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/api/project":{"get":{"tags":["Projects"],"summary":"Find coverage of a NYC project","description":"Find articles and listings about a NYC development by address and/or project name.\n\nSearches NYC real-estate outlets (YIMBY, The Real Deal, Curbed, 6sqft, Crain's, amNY,\nBLDUP, StreetEasy, Commercial Observer, CityRealty) plus the open web, then reads each\narticle's publish date and lead image. Results are newest first; `images` collects the\nlead images. Use this for older coverage that `/api/news` doesn't index.","operationId":"search_project_get_api_project_get","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"US street address, e.g. '265 South Street Manhattan NY 10004'","examples":["265 South Street Manhattan NY 10004"],"title":"Address"},"description":"US street address, e.g. '265 South Street Manhattan NY 10004'"},{"name":"project","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"description":"Project or development name","examples":["Two Bridges"],"title":"Project"},"description":"Project or development name"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"description":"Extra topic words, e.g. 'construction'","title":"Query"},"description":"Extra topic words, e.g. 'construction'"},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Outlet domains to search (repeat the parameter). Defaults to NYC real-estate outlets.","title":"Sites"},"description":"Outlet domains to search (repeat the parameter). Defaults to NYC real-estate outlets."},{"name":"include_web","in":"query","required":false,"schema":{"type":"boolean","description":"Also run an open-web search","default":true,"title":"Include Web"},"description":"Also run an open-web search"},{"name":"enrich","in":"query","required":false,"schema":{"type":"boolean","description":"Fetch articles for publish date, lead image, and full-text matching","default":true,"title":"Enrich"},"description":"Fetch articles for publish date, lead image, and full-text matching"},{"name":"strict","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Keep only results that mention the address or project. Defaults to on.","title":"Strict"},"description":"Keep only results that mention the address or project. Defaults to on."},{"name":"timelimit","in":"query","required":false,"schema":{"anyOf":[{"enum":["d","w","m","y"],"type":"string"},{"type":"null"}],"description":"Time limit: d, w, m, y","title":"Timelimit"},"description":"Time limit: d, w, m, y"},{"name":"region","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2}-[a-z]{2}$","description":"Region code","default":"us-en","title":"Region"},"description":"Region code"},{"name":"max_results","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":1,"description":"Maximum number of results (1-30)","default":10,"title":"Max Results"},"description":"Maximum number of results (1-30)"}],"responses":{"200":{"description":"Project coverage, newest first","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Missing query/address or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"502":{"description":"Upstream search provider error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Projects"],"summary":"Find coverage of a NYC project (JSON)","description":"Same project search as GET, with a JSON body.","operationId":"search_project_post_api_project_post","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSearchRequest"}}}},"responses":{"200":{"description":"Project coverage, newest first","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Missing query/address or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"502":{"description":"Upstream search provider error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/health":{"get":{"tags":["Health"],"summary":"Liveness","description":"Public liveness check. Returns a simple status object.","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"ErrorMessage":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"ErrorMessage"},"ImageDimensions":{"properties":{"width":{"type":"integer","title":"Width","default":0},"height":{"type":"integer","title":"Height","default":0}},"type":"object","title":"ImageDimensions"},"ImageResult":{"properties":{"url":{"type":"string","title":"Url"},"alt":{"type":"string","title":"Alt","default":""},"thumbnail":{"type":"string","title":"Thumbnail","default":""},"title":{"type":"string","title":"Title","default":""},"source":{"type":"string","title":"Source","default":"DuckDuckGo Search Images"},"website":{"$ref":"#/components/schemas/ImageWebsite"},"dimensions":{"$ref":"#/components/schemas/ImageDimensions"},"position":{"type":"integer","title":"Position"}},"type":"object","required":["url","website","dimensions","position"],"title":"ImageResult"},"ImageSearchRequest":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"Search keywords. Wrap words in double quotes to require that exact phrase."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"US street address, e.g. '265 South Street Manhattan NY 10004'. The street line is quoted and results must mention it. Combine with `query` to add topic words (e.g. query='construction')."},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict","description":"Drop results that do not mention the address or every quoted phrase in the query. Defaults to on when `address` is set, off otherwise."},"max_results":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Max Results","description":"Maximum number of results (1-100)","default":10},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"Region code: wt-wt (worldwide), us-en (US), uk-en (UK), es-es (Spain), fr-fr (France)","default":"us-en"},"safesearch":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Safesearch","description":"Safe search level: off, moderate, on","default":"off"},"timelimit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timelimit","description":"Time limit filter: d (day), w (week), m (month), y (year)"},"page":{"anyOf":[{"type":"integer","maximum":10.0,"minimum":1.0},{"type":"null"}],"title":"Page","description":"Page number for pagination (1-10)","default":1},"backend":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Backend","description":"Backend: auto, bing, duckduckgo. Filters and timelimit force duckduckgo (bing ignores them).","default":"auto"},"size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Size","description":"Size filter: Small, Medium, Large, Wallpaper"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Color filter: Monochrome, Red, Orange, Yellow, Green, Blue, Purple, Pink, Brown, Black, Gray, Teal, White"},"type_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type Image","description":"Type filter: Photo, Clipart, Gif, Transparent, Line"},"layout":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Layout","description":"Layout filter: Square, Tall, Wide"},"license_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Image","description":"License filter: Public, Share, ShareCommercially, Modify, ModifyCommercially"},"validate_images":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Validate Images","description":"Validate image URLs (slower but more reliable - checks if images are accessible)","default":false}},"type":"object","title":"ImageSearchRequest","description":"Request model for image search","example":{"address":"265 South Street Manhattan NY 10004","max_results":10,"region":"us-en","safesearch":"off","validate_images":false}},"ImageWebsite":{"properties":{"url":{"type":"string","title":"Url","default":""},"title":{"type":"string","title":"Title","default":""},"name":{"type":"string","title":"Name","default":""}},"type":"object","title":"ImageWebsite"},"NewsArticle":{"properties":{"title":{"type":"string","title":"Title","default":""},"body":{"type":"string","title":"Body","default":""},"url":{"type":"string","title":"Url","default":""},"image":{"type":"string","title":"Image","default":""},"source":{"type":"string","title":"Source","default":""},"date":{"type":"string","title":"Date","default":""},"domain":{"type":"string","title":"Domain","default":""},"position":{"type":"integer","title":"Position"}},"type":"object","required":["position"],"title":"NewsArticle"},"NewsResponse":{"properties":{"articles":{"items":{"$ref":"#/components/schemas/NewsArticle"},"type":"array","title":"Articles"},"count":{"type":"integer","title":"Count"},"query":{"type":"string","title":"Query"},"effective_query":{"type":"string","title":"Effective Query"},"address":{"anyOf":[{"$ref":"#/components/schemas/ParsedAddressModel"},{"type":"null"}]},"strict":{"type":"boolean","title":"Strict","default":false},"filtered_out":{"type":"integer","title":"Filtered Out","default":0},"max_results":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Results"}},"type":"object","required":["articles","count","query","effective_query"],"title":"NewsResponse","example":{"address":{"city":"Manhattan","number":"265","state":"NY","street":"South Street","street_line":"265 South Street","zip_code":"10004"},"articles":[{"body":"The 70-story tower at 265 South Street on the Lower East Side...","date":"2026-08-30T14:00:00+00:00","domain":"example.com","image":"https://example.com/news/265.jpg","position":1,"source":"Example News","title":"Two Bridges tower at 265 South Street tops out","url":"https://example.com/news/265-south-street"}],"count":1,"effective_query":"\"265 South Street\" Manhattan NY","filtered_out":4,"max_results":10,"query":"265 South Street Manhattan NY 10004","strict":true}},"NewsSearchRequest":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"Search keywords. Wrap words in double quotes to require that exact phrase."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"US street address, e.g. '265 South Street Manhattan NY 10004'. The street line is quoted and results must mention it. Combine with `query` to add topic words (e.g. query='construction')."},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict","description":"Drop results that do not mention the address or every quoted phrase in the query. Defaults to on when `address` is set, off otherwise."},"max_results":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Max Results","description":"Maximum number of results (1-100)","default":10},"region":{"type":"string","pattern":"^[a-z]{2}-[a-z]{2}$","title":"Region","description":"Region code, e.g. us-en, uk-en, wt-wt","default":"us-en"},"safesearch":{"type":"string","enum":["on","moderate","off"],"title":"Safesearch","description":"Safe search level: off, moderate, on","default":"off"},"timelimit":{"anyOf":[{"type":"string","enum":["d","w","m","y"]},{"type":"null"}],"title":"Timelimit","description":"Time limit: d (day), w (week), m (month), y (year)"},"page":{"type":"integer","maximum":10.0,"minimum":1.0,"title":"Page","description":"Page number for pagination (1-10)","default":1},"backend":{"type":"string","enum":["auto","bing","duckduckgo","yahoo"],"title":"Backend","description":"Backend: auto, bing, duckduckgo, yahoo. auto falls back across engines.","default":"auto"}},"type":"object","title":"NewsSearchRequest","description":"Request model for news search","example":{"address":"265 South Street Manhattan NY 10004","max_results":10,"region":"us-en","timelimit":"y"}},"ParsedAddressModel":{"properties":{"number":{"type":"string","title":"Number"},"street":{"type":"string","title":"Street"},"street_line":{"type":"string","title":"Street Line"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"}},"type":"object","required":["number","street","street_line"],"title":"ParsedAddressModel"},"ProjectImage":{"properties":{"image":{"type":"string","title":"Image"},"title":{"type":"string","title":"Title","default":""},"url":{"type":"string","title":"Url"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"source":{"type":"string","title":"Source","default":""}},"type":"object","required":["image","url"],"title":"ProjectImage"},"ProjectResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ProjectResult"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"images":{"items":{"$ref":"#/components/schemas/ProjectImage"},"type":"array","title":"Images"},"address":{"anyOf":[{"$ref":"#/components/schemas/ParsedAddressModel"},{"type":"null"}]},"project":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project"},"identities":{"items":{"type":"string"},"type":"array","title":"Identities"},"queries":{"items":{"type":"string"},"type":"array","title":"Queries"},"sites":{"items":{"type":"string"},"type":"array","title":"Sites"},"strict":{"type":"boolean","title":"Strict","default":true},"filtered_out":{"type":"integer","title":"Filtered Out","default":0},"failed_queries":{"type":"integer","title":"Failed Queries","default":0},"max_results":{"type":"integer","title":"Max Results"}},"type":"object","required":["results","count","images","identities","queries","sites","max_results"],"title":"ProjectResponse","example":{"count":1,"failed_queries":0,"filtered_out":12,"identities":["265 South Street","Two Bridges"],"images":[{"date":"2021-11-19T17:31:40+00:00","image":"https://static.therealdeal.com/wp-content/uploads/2021/11/ft-Joe-Chetrit-buying-Two-Bridges-site.jpg","source":"The Real Deal","title":"Joe Chetrit buying Two Bridges site","url":"https://therealdeal.com/new-york/2021/11/19/joe-chetrit-buying-second-two-bridges-site/"}],"max_results":10,"queries":["\"265 South Street\" (site:newyorkyimby.com OR site:therealdeal.com OR ...)"],"results":[{"date":"2021-11-19T17:31:40+00:00","domain":"therealdeal.com","enriched":true,"image":"https://static.therealdeal.com/wp-content/uploads/2021/11/ft-Joe-Chetrit-buying-Two-Bridges-site.jpg","mentions":["265 South Street","Two Bridges"],"outlet":true,"position":1,"snippet":"Joe Chetrit is buying the second Two Bridges development site...","source":"The Real Deal","title":"Joe Chetrit buying Two Bridges site","url":"https://therealdeal.com/new-york/2021/11/19/joe-chetrit-buying-second-two-bridges-site/"}],"strict":true}},"ProjectResult":{"properties":{"title":{"type":"string","title":"Title","default":""},"url":{"type":"string","title":"Url"},"domain":{"type":"string","title":"Domain","default":""},"source":{"type":"string","title":"Source","default":""},"snippet":{"type":"string","title":"Snippet","default":""},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"},"outlet":{"type":"boolean","title":"Outlet","default":false},"mentions":{"items":{"type":"string"},"type":"array","title":"Mentions","default":[]},"enriched":{"type":"boolean","title":"Enriched","default":false},"position":{"type":"integer","title":"Position"}},"type":"object","required":["url","position"],"title":"ProjectResult"},"ProjectSearchRequest":{"properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"US street address of the project, e.g. '265 South Street Manhattan NY 10004'"},"project":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Project","description":"Project or development name, e.g. 'Two Bridges' or 'One Manhattan Square'"},"query":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Query","description":"Extra topic words added to every search, e.g. 'construction' or 'lawsuit'"},"sites":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":20},{"type":"null"}],"title":"Sites","description":"Outlet domains to search. Defaults to NYC real-estate outlets (see /api/info)."},"include_web":{"type":"boolean","title":"Include Web","description":"Also run an open-web search besides the outlet searches","default":true},"enrich":{"type":"boolean","title":"Enrich","description":"Fetch each article to read its publish date, lead image, and full text (slower, finds more)","default":true},"strict":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Strict","description":"Keep only results that mention the address or project name. Defaults to on."},"timelimit":{"anyOf":[{"type":"string","enum":["d","w","m","y"]},{"type":"null"}],"title":"Timelimit","description":"Time limit: d (day), w (week), m (month), y (year)"},"region":{"type":"string","pattern":"^[a-z]{2}-[a-z]{2}$","title":"Region","description":"Region code, e.g. us-en","default":"us-en"},"max_results":{"type":"integer","maximum":30.0,"minimum":1.0,"title":"Max Results","description":"Maximum number of results (1-30)","default":10}},"type":"object","title":"ProjectSearchRequest","description":"Request model for NYC project coverage search","example":{"address":"265 South Street Manhattan NY 10004","enrich":true,"max_results":10,"project":"Two Bridges"}},"SearchResponse":{"properties":{"images":{"items":{"$ref":"#/components/schemas/ImageResult"},"type":"array","title":"Images"},"count":{"type":"integer","title":"Count"},"query":{"type":"string","title":"Query"},"effective_query":{"type":"string","title":"Effective Query"},"address":{"anyOf":[{"$ref":"#/components/schemas/ParsedAddressModel"},{"type":"null"}]},"strict":{"type":"boolean","title":"Strict","default":false},"filtered_out":{"type":"integer","title":"Filtered Out","default":0},"max_results":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Results"}},"type":"object","required":["images","count","query","effective_query"],"title":"SearchResponse","example":{"count":1,"effective_query":"butterfly","filtered_out":0,"images":[{"alt":"Butterfly","dimensions":{"height":1080,"width":1920},"position":1,"source":"DuckDuckGo Search Images","thumbnail":"https://example.com/thumb.jpg","title":"Butterfly","url":"https://example.com/image.jpg","website":{"name":"example.com","title":"Example","url":"https://example.com"}}],"max_results":5,"query":"butterfly","strict":false}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for /api/search, /api/news, and /api/project. Send it in the X-API-Key header."}}},"tags":[{"name":"Search","description":"Image search. Requires the `X-API-Key` header. Use **Authorize** before Try it out."},{"name":"News","description":"News search. Requires the `X-API-Key` header. Use `address` for precise US address matches."},{"name":"Projects","description":"NYC project coverage by address and/or project name, from real-estate outlets and the open web. Requires the `X-API-Key` header."},{"name":"Info","description":"Public metadata about this API."},{"name":"Health","description":"Public liveness checks for load balancers."}],"servers":[{"url":"/","description":"This server"}],"x-tagGroups":[{"name":"API","tags":["Search","News","Projects"]},{"name":"Status","tags":["Info","Health"]}]}