> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bonai.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Search articles

> Search for news articles with various filters. This is the v1 search endpoint.



## OpenAPI

````yaml /openapi/bonai-news-api-2022-01-01.json get /search
openapi: 3.0.3
info:
  title: Bonai News API
  version: '2022-01-01'
  description: >-
    A comprehensive news aggregation and search API providing access to
    articles, publishers, and trending topics across multiple languages and
    countries. The API is versioned via the `api-version` header. This is
    version `2022-01-01` which uses the original v1 response envelope with
    `status`, `totalResults`, and `articles` fields.
servers:
  - url: https://api.bonai.io/news
    description: Production
security: []
paths:
  /search:
    get:
      summary: Search articles
      description: >-
        Search for news articles with various filters. This is the v1 search
        endpoint.
      operationId: searchArticles
      parameters:
        - name: q
          in: query
          required: true
          description: Search query string
          schema:
            type: string
            minLength: 1
        - name: country
          in: query
          description: Country code (e.g., 'us', 'uk')
          schema:
            type: string
            default: US
        - name: language
          in: query
          description: Language code (e.g., 'en', 'es')
          schema:
            type: string
            default: en
        - name: pageSize
          in: query
          description: Number of results per page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: from
          in: query
          description: Start date for date range filter
          schema:
            type: string
        - name: to
          in: query
          description: End date for date range filter
          schema:
            type: string
        - name: publisher
          in: query
          description: Publisher URL to filter by
          schema:
            type: string
            format: uri
        - name: sortBy
          in: query
          description: Sort order
          schema:
            type: string
        - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1SearchResponse'
        '400':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '401':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
      security:
        - bearerAuth: []
components:
  parameters:
    ApiVersionHeader:
      name: api-version
      in: header
      required: false
      schema:
        type: string
        enum:
          - '2026-08-01'
          - '2024-01-01'
          - '2022-01-01'
      description: API version to consume. Defaults to the latest version (2026-08-01).
  schemas:
    V1SearchResponse:
      type: object
      required:
        - status
        - totalResults
        - articles
      properties:
        status:
          type: string
          example: ok
        totalResults:
          type: integer
          description: Total number of matching items
        articles:
          type: array
          items:
            $ref: '#/components/schemas/V1Article'
    V1ErrorResponse:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: string
          example: error
        code:
          type: number
          description: HTTP status code
        message:
          type: string
    V1Article:
      type: object
      required:
        - title
        - url
        - published_date
      properties:
        title:
          type: string
        url:
          type: string
          format: uri
        published_date:
          type: string
          description: Publish date
        publisher:
          type: object
          properties:
            name:
              type: string
              nullable: true
            url:
              type: string
            favicon:
              type: string
              nullable: true
        keywords:
          type: array
          items:
            type: string
        author:
          type: array
          items:
            type: string
        description:
          type: string
          nullable: true
        thumbnail:
          type: string
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Bonai API key, sent as `Authorization: Bearer <key>`. The `api-key`
        and `x-api-key` headers are also accepted.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.