Guavy Logo GUAVY
Instruments Search Instruments
GET
·
/api/v1/instruments/search-instruments

Search Instruments

Search for instruments in our database using a query string. Returns up to 5 matches on symbol or name.

Attributes

query
string
Required
The text to find instrument matches on symbol or name.

API Request

Example Request with cURL

curl \
--request GET \
--url     'https://data.guavy.com/api/v1/instruments/search-instruments/<query>' \
--header 'Authorization: Bearer YOUR-GUAVY-ACCESS-TOKEN' \
--header 'Content-Type: application/json'

This request format works across all modern HTTP clients, including Python requests, JavaScript fetch, and other programming language libraries.

Example Response for /api/v1/instruments/search-instruments/bit

{
  "instruments": [
    {
      "logo": "https://data.guavy.com/static/icon/22974.png",
      "name": "Bittensor",
      "symbol": "TAO"
    },
    {
      "logo": "https://data.guavy.com/static/icon/1.png",
      "name": "Bitcoin",
      "symbol": "BTC"
    },
    {
      "logo": "https://data.guavy.com/static/icon/1831.png",
      "name": "Bitcoin Cash",
      "symbol": "BCH"
    },
    {
      "logo": "https://data.guavy.com/static/icon/11841.png",
      "name": "Arbitrum",
      "symbol": "ARB"
    },
    {
      "logo": "https://data.guavy.com/static/icon/11092.png",
      "name": "Bitget Token",
      "symbol": "BGB"
    }
  ]
}

Response Object

instruments
array[object]
Array of instruments objects with the following keys:
logo
string
URL to the instrument's logo image.
name
string
The name of the instrument.
symbol
string
The symbol of the instrument.

API Limits

The Guavy API has a limit of 10 simultaneous connections. You'll receive a 429 error if you reach the limit. At exceptionally high volumes, you may receive an HTTP 429 or 403 without a JSON body.

We recommend that you cache frequently accessed values that do not change often in your application's data store. This will prevent your application from bumping up against the throttling limitations and will likely provide faster access to that data.

Account Limits

Your Guavy account will typically have a licensed limit of at least 100,000 API calls per month. In addition, there is a limit of 10,000 API calls per day. If you reach these limits, you will receive a 429 error.

Connection Timeouts

The Guavy API has a 120-second timeout on API calls. You may see this type of timeout after you've made a network socket connection and are already sending and receiving data. Response times are dependent on the complexity of your request and the general load across Guavy. Some endpoints in the Guavy API return values that are large and slow to calculate.

Was this helpful?
Feedback option #{picture.id}
Feedback option #{picture.id}
Feedback option #{picture.id}
Feedback option #{picture.id}

© 2025 Guavy Inc. All rights reserved.