Skip to main content
GET
Search articles

Authorizations

api-key
string
header
required

Your Bonai API key. Create one in the Bonai console (https://console.bonai.io).

Headers

api-version
enum<string>

API version to consume. Defaults to the latest version (2024-01-01).

Available options:
2024-01-01

Query Parameters

query
string
required

Search query string

Minimum string length: 1
language
string

Language code (e.g., 'en', 'es')

country
string

Country code (e.g., 'us', 'uk')

publisher
string<uri>

Publisher URL to filter by

paywall
enum<string>

Filter by paywall status

Available options:
true,
false
from
string

Start date for date range filter

to
string

End date for date range filter

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:25

Number of results per page

Required range: 1 <= x <= 1000
sort
enum<string>

Sort order

Available options:
relevance,
date

Response

Successful response

success
enum<boolean>
required
Available options:
true
size
integer
required

Number of items in the current page

totalHits
integer
required

Total number of matching items

hitsPerPage
integer
required

Maximum items per page applied for this request

page
integer
required

Current page number

totalPages
integer
required

Total number of pages

timeMs
number
required

Query execution time in milliseconds

data
object[]
required