Reference

Security Search

GET/v2/reference/search

Search across stocks, ETFs, funds, and crypto by name or ticker.

Included in: Growth.

Authentication

Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key · Authentication guide

Parameters

Name	In	Type	Required	Description
q	query	string	yes	Search query (name, ticker, or ISIN) Example `Apple`
limit	query	integer (int32)	no	Maximum number of results to return (default 100, max 1000) Default `100`
offset	query	integer (int32)	no	Number of results to skip for pagination (default 0) Default `0`
cursor	query	string	no	Opaque cursor for cursor-based pagination. When provided, returns results after the cursor position. Takes precedence over offset.

Try it

q required query

Search query (name, ticker, or ISIN)

GET /v2/reference/search?q=Apple

API key

Sent only to api.bavest.co for this request; not stored.

Sign in to send Get an API keySends with the key above, or sign in to use your account's key. Each request counts as one API call.

curl 'https://api.bavest.co/v2/reference/search?q=Apple' \
  -H "x-api-key: $BAVEST_API_KEY"

Samples read your key from BAVEST_API_KEY and follow the form.

Example response 200

{
  "data": [
    {
      "symbol": "APC.DE",
      "companyName": "Apple Inc.",
      "isin": "US0378331005",
      "type": "ADR",
      "subtype": null,
      "isEtf": false,
      "isAdr": true,
      "isFund": false,
      "exchange": "XETRA",
      "isActivelyTrading": true
    },
    {
      "symbol": "AAPL",
      "companyName": "Apple Inc.",
      "isin": "US0378331005",
      "type": "EQUITY",
      "subtype": null,
      "isEtf": false,
      "isAdr": false,
      "isFund": false,
      "exchange": "NASDAQ",
      "isActivelyTrading": true
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 100,
    "totalPages": 2,
    "totalCount": 104,
    "parameters": {
      "limit": "100",
      "q": "Apple"
    },
    "time": 4
  }
}

From the docs, not your data. Long lists are cut to 3 items.

Response 200

Successful response · application/json

dataarray of SearchResult
- symbolstringrequired
  Ticker symbol
  Example AAPL
- typestringrequired
  Asset class of the security (e.g. EQUITY, ETF, ETP, MUTUAL_FUND, CLOSED_END_FUND, BOND, ADR, INDEX, CRYPTO_CURRENCY, CURRENCY, COMMODITY, CERTIFICATE).
  
  EQUITY und STOCK sind im Bestand beide vergeben und meinen dasselbe; die Suche vereinheitlicht sie zu EQUITY und stellt das urspruengliche STOCK in subtype.
  Example EQUITY
- subtypestring | null
  Feinere Klassifizierung, sofern vorhanden. Traegt unter anderem das urspruengliche STOCK, wenn type zu EQUITY vereinheitlicht wurde. null, wenn keine feinere Angabe vorliegt.
  Example STOCK
- exchangestring | null
  Primary listing exchange. null, wenn zu dem Papier keine Boerse gefuehrt wird, etwa bei OTC-Anleihen ohne Handelsplatz.
  Example NASDAQ
- isinstring | null
  ISIN code (if available)
  Example US0378331005
- companyNamestring
  Full company name
  Example Leverage Shares 3x Apple ETC
- isActivelyTradingboolean | null
  Whether the security is actively trading. null, wenn die Quelle dazu nichts sagt; das betrifft vor allem Publikumsfonds, fuer die kein Handelsstatus gefuehrt wird (z. B. LU0327386487).
  Example true
- isAdrboolean
  Whether the security is an American Depositary Receipt
  Example false
- isEtfboolean
  Whether the security is an ETF
  Example true
- isFundboolean
  Whether the security is a fund
  Example false
- isReitboolean | null
  Whether the company is a REIT (real estate investment trust): its industry starts with "REIT", e.g. Realty Income "REIT - Retail". Never true for ETFs or funds. null when no industry is known.
  Example false
metaResponseMeta
Response metadata for paginated endpoints. Offset pagination returns page/pageSize/totalPages/totalCount; cursor pagination returns pageSize/hasMore/nextCursor and totalCount only when known.
- timeinteger
  Server-side processing time in milliseconds
  Example 17
- parametersobject
  Echo of the request parameters the endpoint resolved
- pageinteger
  Current page number (offset pagination)
  Example 1
- pageSizeinteger
  Number of results per page
  Example 50
- totalPagesinteger
  Total number of pages (offset pagination)
  Example 2
- totalCountinteger
  Total number of results across all pages
  Example 100
- hasMoreboolean
  Whether more results follow (cursor pagination)
- nextCursorstring | null
  Cursor for the next page (cursor pagination), null on the last page

Errors

400Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive).
401Missing or invalid API key.
404Resource not found.
429Rate limit exceeded. Retry after the `Retry-After` header interval.
500An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
502Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
504The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
defaultAn unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.