Introduction

Overview

Whether you’re building trading bots, conducting in-depth market research, or developing financial applications, the Guavy API equips you with the essential insights needed to stay ahead in the fast-paced world of cryptocurrency.

To use the Guavy API, you need a Guavy account. What you can do with the API depends on what level of Guavy plan you have. Once you have an account and are logged in, you can get an API key and begin making calls to the API.

You need an API key to access the Guavy API. If you don't have one yet, you can request API key.

Using the Guavy API

You can also use the Guavy API to handle data in different ways for different purposes. If you are syncing a large amount of data with Guavy, you can use batches to avoid hitting the API request limits.

For building applications that let other users access Guavy data you will need a reseller license.

If you're developing an app for iOS or Android, then a mobile-focused subset of the Guavy API's functionality, can be licensed separately. This allows you to build mobile applications that can access Guavy data without needing a full reseller license.

API structure

The Guavy API generally follows REST conventions, with some deviations.

• All responses are wrapped in a top-level object.
• Responses return either `Success` or `Error`.
• Errors include a message field with details about the error.
• All responses use the generic JSON content type.
• Responses use the generic JSON content type.

We use the API Specification to describe each endpoint. The API self-description also contains type information to help you error-check your requests.

The root url for customized API documentation is https://<dc>/api/v3/openapi.json. The <dc> part of the URL corresponds to the custom data center for your account. The base API specification is available at https://api.guavy.com/api/v3/openapi.json.

However, if you are using the Guavy API in our multi-tenanted data center then all API endpoints for your account are available relative to https://api.guavy.com.

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.

The example below demonstrates how to make an authenticated API request using cURL. All Guavy API endpoints require authentication via a Bearer token, which should be included in the Authorization header. This token identifies your account and determines your access level to various endpoints.

To use this example:

1. Replace YOUR-GUAVY-ACCESS-TOKEN with your personal API key from the Guavy dashboard
2. The URL includes the specific endpoint path shown in the documentation
3. All requests use HTTPS for secure data transmission

curl --request GET \

--url 'https://api.guavy.com/api/v3/endpoint' \
--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.