API

Every currentsapi.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Name	Type	Required	Description
`categories`	`string[]`	Yes	—
`description`	`string`	No	—
`status`	`string`	No	—

Languages

get

languages.get List valid language codes Risk: read

await corsair.currentsapi.api.languages.get({});

Input: empty object Output

Name	Type	Required	Description
`languages`	`object`	Yes	—
`description`	`string`	No	—
`status`	`string`	No	—

languages full type

{
}

Latest

get

latest.get Get latest news headlines Risk: read

await corsair.currentsapi.api.latest.get({});

Input

Name	Type	Required	Description
`language`	`string`	Yes	—
`category`	`string`	No	—
`country`	`string`	No	—
`page_number`	`number`	No	—
`page_size`	`number`	No	—
`type`	`1 \| 2 \| 3`	No	—
`domain`	`string`	No	—
`domain_not`	`string`	No	—
`author`	`string`	No	—

Output

Name	Type	Required	Description
`status`	`ok \| error`	Yes	—
`news`	`object[]`	Yes	—
`page`	`number`	Yes	—
`query_matched`	`boolean`	No	—
`query_scope`	`string`	No	—
`reason`	`string`	No	—
`page_has_results`	`boolean`	No	—

news full type

{
  id: string,
  title: string,
  description?: string,
  url?: string,
  author?: string,
  image?: string,
  language?: string,
  category?: string[],
  source_category?: string[],
  published?: string
}[]

Regions

get

regions.get List valid country region codes Risk: read

await corsair.currentsapi.api.regions.get({});

Input: empty object Output

Name	Type	Required	Description
`regions`	`object`	Yes	—
`description`	`string`	No	—
`status`	`string`	No	—

regions full type

{
}

Search

get

search.get Search news articles by keywords with filters Risk: read

await corsair.currentsapi.api.search.get({});

Input

Name	Type	Required	Description
`keywords`	`string`	No	—
`query`	`string`	No	—
`language`	`string`	Yes	—
`category`	`string`	No	—
`country`	`string`	No	—
`start_date`	`string`	No	—
`end_date`	`string`	No	—
`page_number`	`number`	No	—
`page_size`	`number`	No	—
`limit`	`number`	No	—
`type`	`1 \| 2 \| 3`	No	—
`domain`	`string`	No	—
`domain_not`	`string`	No	—
`author`	`string`	No	—
`has_image`	`boolean`	No	—
`has_description`	`boolean`	No	—

Output

Name	Type	Required	Description
`status`	`ok \| error`	Yes	—
`news`	`object[]`	Yes	—
`page`	`number`	Yes	—
`query_matched`	`boolean`	No	—
`query_scope`	`string`	No	—
`reason`	`string`	No	—
`page_has_results`	`boolean`	No	—

news full type

{
  id: string,
  title: string,
  description?: string,
  url?: string,
  author?: string,
  image?: string,
  language?: string,
  category?: string[],
  source_category?: string[],
  published?: string
}[]

Overview

Plugins

Categories

get

Languages

get

Latest

get

Regions

get

Search

get

​Categories

​get

​Languages

​get

​Latest

​get

​Regions

​get

​Search

​get

Categories

get

Languages

get

Latest

get

Regions

get

Search

get