Requests
Learn how to authenticate and make requests to the Guavy API using API keys or OAuth 2 tokens.
Connecting to the API
You can authenticate requests using either your API key or an OAuth access token, depending on your use case. You should use an API key if you're writing code that tightly couples your application data to your Guavy account data; if you ever need to access someone else's Guavy account data, you should use OAuth 2.
If you're integrating with the Guavy API using one of the official client libraries, you won't need to worry about the implementation details for authentication.
Authenticate With an API Key or OAuth 2 Token
API keys and OAuth 2 tokens can be used to make authenticated requests the same way. We'll refer to both as tokens.
You can either use HTTP Basic Authentication or Bearer Authentication.
HTTP Basic Authentication:
curl \
--request GET \
--url 'https://data.guavy.com/api/v1/instruments/get-detail/BTC' \
--header 'Authorization: Bearer YOUR-GUAVY-ACCESS-TOKEN' \
--header 'Content-Type: application/json'
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.