Authentication

Get Your API Key

The only way to authenticate a request to the Guavy Crypto API is using an API key.

• ↳ Navigate to the API request form and fill out each field.
• ↳ If you already have an API key listed to use for your application, simply copy it.

Install the Client Library for Your Language

Since the Guavy API is a RESTful API, you can use any HTTP client library to make requests to the API.

We do not offer an official client library for the Guavy API, but we do offer a number of proprietary client libraries that you can use to make requests to the API when your license includes custom routes.

These libraries handle authentication, request signing, and response parsing for you, which can make it easier for some development teams to work with the API. Reach out to your account manager to learn more about these proprietary libraries.

Make Your First API Call

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://data.guavy.com/api/v1/ping' \
--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.

To test that you have everything set up correctly, we'll make a simple request to the Verify endpoint. Hitting this endpoint acts as a health check on the Guavy API service; it won't affect your account in any way.

If everything was set up correctly and the request to ping will be successful and you will get the JSON pong message as a response.,