Getting Started

API Overview

Whether you’re building trading bots, conducting in-depth market research, running technical analysis, or developing financial applications, the Guavy API equips you with the sentiment, scores, and news you need across crypto, forex, and commodities.

To use the Guavy API, you need a Guavy account. All markets (crypto, forex, commodities) are available on every plan; your plan sets your token budget and commercial-use rights, not which markets you can access. Once you have an account and are logged in, you can get an API key and begin making calls to the API.

Using the Guavy API

You can 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.

Commercial use in apps, funds, or agents, including white-label data and redistribution, is covered by a Business license.

Everything is plain REST over HTTPS, so it works the same from a backend service, a script, or a mobile app, with no separate SDK or mobile license required.

API Structure

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

• Endpoints represent the various API routes available.
• Requests are typically made using standard HTTP methods like GET and POST.
• Requests require authentication using your API key, sent as a Bearer token.
• Responses are typically JSON objects.
• Errors include standard HTTP status codes and messages.
• Actions are usually represented by HTTP methods.
• Responses use the generic JSON content type.

We use an API specification to describe each endpoint. The API documentation also contains type information to help validate and process responses.