GET
/
news
curl --request GET \
  --url https://api.ydc-index.io/news \
  --header 'X-API-Key: <api-key>'
{
  "news": {
    "results": [
      {
        "url": "https://news.you.com",
        "title": "Breaking News about the World's Greatest Search Engine!",
        "description": "Search on YDC for the news",
        "type": "news",
        "age": "18 hours ago",
        "page_age": "2 days",
        "breaking": true,
        "page_fetched": "2023-10-12T23:00:00Z",
        "thumbnail": {
          "original": "https://reuters.com/news.jpg"
        },
        "meta_url": {
          "scheme": "https",
          "netloc": "reuters.com",
          "hostname": "www.reuters.com",
          "path": "› 2023  › 10  › 18  › politics  › inflation  › index.html"
        }
      }
    ]
  }
}

Authorizations

X-API-Key
string
headerrequired

Query Parameters

query
string
required

Query string for searching index

count
integer

The max number of web results to return, must be under 20

offset
integer

The offset, in multiples of count. I.e if count = 5, and offset=1, the API will return results 5-10. The maximum value for offset is 9.

country
string

Country Code, one of ['AR', 'AU', 'AT', 'BE', 'BR', 'CA', 'CL', 'DK', 'FI', 'FR', 'DE', 'HK', 'IN', 'ID', 'IT', 'JP', 'KR', 'MY', 'MX', 'NL', 'NZ', 'NO', 'CN', 'PL', 'PT', 'PH', 'RU', 'SA', 'ZA', 'ES', 'SE', 'CH', 'TW', 'TR', 'GB', 'US']

search_lang
string

Language codes, one of ['ar', 'eu', 'bn', 'bg', 'ca', 'Simplified', 'Traditional', 'hr', 'cs', 'da', 'nl', 'en', 'United', 'et', 'fi', 'fr', 'gl', 'de', 'gu', 'he', 'hi', 'hu', 'is', 'it', 'jp', 'kn', 'ko', 'lv', 'lt', 'ms', 'ml', 'mr', 'Bokmål', 'pl', 'Brazil', 'Portugal', 'pa', 'ro', 'ru', 'Cyrylic', 'sk', 'sl', 'es', 'sv', 'ta', 'te', 'th', 'tr', 'uk', 'vi']

ui_lang
string

User interface language for the response, one of ['es-AR', 'en-AU', 'de-AT', 'nl-BE', 'fr-BE', 'pt-BR', 'en-CA', 'fr-CA', 'es-CL', 'da-DK', 'fi-FI', 'fr-FR', 'de-DE', 'SAR', 'en-IN', 'en-ID', 'it-IT', 'ja-JP', 'ko-KR', 'en-MY', 'es-MX', 'nl-NL', 'English', 'no-NO', 'of', 'pl-PL', 'the', 'ru-RU', 'English', 'es-ES', 'sv-SE', 'fr-CH', 'de-CH', 'Chinese', 'tr-TR', 'English', 'English', 'Spanish']

safesearch
string

Safesearch settings, one of off, moderate, strict, defaults to moderate

spellcheck
boolean

Whether to spell check query or not, defaults to True

recency
enum<string>

Recency for articles requested.

Available options:
day,
week,
month,
year

Response

200 - application/json
news
object
Web LLM (RAG)