Skip to main content
GET
/
api
/
v1
/
search
Search across all resource types
curl --request GET \
  --url http://localhost:3000/api/v1/search \
  --header 'Authorization: Bearer <token>'
{
  "results": {
    "articles": [
      {
        "id": "art_abc123def",
        "title": "Title",
        "title_en": "Title",
        "summary_en": "Summary",
        "article_url": "https://example.com/articles/abc123def",
        "content_type": "news",
        "published_at": "2023-11-07T05:31:56Z",
        "category": {
          "id": "<string>",
          "name": "<string>"
        },
        "source": {
          "name": "Source Name",
          "domain": "example.com"
        },
        "story_ids": [
          "<string>"
        ],
        "companies": [
          {
            "id": "<string>",
            "name": "<string>",
            "ticker_symbol": "<string>"
          }
        ],
        "country": "SE",
        "image_url": "<string>"
      }
    ],
    "stories": [
      {
        "id": "<string>",
        "title": "<string>",
        "summary": "<string>",
        "article_count": 123,
        "published_at": "2023-11-07T05:31:56Z",
        "article_ids": [
          "<string>"
        ],
        "country": "<string>",
        "topics": [
          "<string>"
        ],
        "companies": [
          {
            "id": "<string>",
            "name": "<string>",
            "ticker_symbol": "<string>"
          }
        ],
        "category": {
          "id": "<string>",
          "name": "<string>"
        }
      }
    ],
    "companies": [
      {
        "id": "comp_apple123",
        "name": "Apple Inc.",
        "slug": "apple-inc",
        "ticker_symbol": "VOLV-B.ST",
        "exchange": {
          "id": "<string>",
          "name": "<string>",
          "mic_code": "<string>"
        }
      }
    ],
    "countries": [
      {
        "id": "ctry_sweden12",
        "name": "Sweden",
        "iso2_code": "SE"
      }
    ],
    "exchanges": [
      {
        "id": "exch_nasdaq1",
        "name": "Nasdaq Stockholm",
        "mic_code": "XSTO",
        "acronym": "NASDAQ",
        "country": {
          "id": "<string>",
          "name": "<string>",
          "iso2_code": "<string>"
        }
      }
    ],
    "indices": [
      {
        "id": "idx_omxs30abc",
        "name": "OMX Stockholm 30",
        "symbol": "OMXS30",
        "pan_nordic": false,
        "exchange": {
          "id": "<string>",
          "name": "<string>",
          "mic_code": "<string>"
        }
      }
    ]
  },
  "pagination": {
    "articles": {
      "count": 123,
      "limit": 123
    },
    "stories": {
      "count": 123,
      "limit": 123
    },
    "companies": {
      "count": 123,
      "limit": 123
    },
    "countries": {
      "count": 123,
      "limit": 123
    },
    "exchanges": {
      "count": 123,
      "limit": 123
    },
    "indices": {
      "count": 123,
      "limit": 123
    }
  }
}

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token

Query Parameters

q
string
required

Full-text search query (2-200 characters).

type
string

Comma-separated list of resource types to search. Defaults to all types. Valid values: articles, stories, companies, countries, exchanges.

limit
integer

Maximum number of results per resource type (default 5, max 25).

Response

Search results

results
object
required
pagination
object
required