Get Scorecard
Attributes
API Request
Example Request with cURL
curl \
--request GET \
--url 'https://guavy.com/api/v2/forex/instruments/scorecard/<symbol>' \
--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/v2/forex/instruments/scorecard/EUR
{
"action": "Hold",
"buy_and_hold_percentage": 6.876315325922705,
"icon": "",
"in_trade": false,
"name": "Euro",
"percentage_profit": 3.9560655588500824,
"rank": 1,
"score": 4.4,
"strategy": "conservative",
"symbol": "EUR",
"total_trades": 7,
"trend": "Neutral",
"trend_duration": 0
}
Response Object
Token Costs
Each API call consumes tokens from your monthly budget. Endpoints that return richer or deeper data cost more tokens. Historical endpoints scale with the amount of data requested.
You never have to guess how much is left: every metered response carries your balance in
x-tokens-* headers — x-tokens-cost (what this call cost),
x-tokens-limit / x-tokens-remaining (monthly), and
x-tokens-limit-today / x-tokens-remaining-today (daily). The
remaining values are net of any credit applied to the same request.
| Endpoint | Token Cost |
|---|---|
| GET /api/v2/forex/instruments/list-symbols | 1 |
| GET /api/v2/forex/newsroom/get-recent-briefs/:symbol | 3 – 8 (scales with limit) |
| GET /api/v2/forex/newsroom/search-briefs/:symbol | 3 – 8 (scales with limit) |
| GET /api/v2/forex/newsroom/get-article/:id | 3 |
| GET /api/v2/forex/sentiment/get-sentiment-history/:symbol | 3 – 12 (scales with limit) |
| GET /api/v2/forex/technical-analysis/get-price-history/:symbol | 5 |
| GET /api/v2/forex/technical-analysis/get-indicators/:symbol | 8 |
| GET /api/v2/forex/instruments/scorecard/:symbol | 10 |
| GET /api/v2/forex/trades/get-current-trend/:symbol | 3 |
| GET /api/v2/forex/trades/get-trend-segments/:symbol | 5 |
Account Limits
Each plan includes a monthly token budget: 3,000 for Sandbox, 250,000 for Quant, and 1,000,000 for Pro. Your monthly plan budget resets to the full amount on the 1st of each month — unused base tokens don't carry over. You can top up at any time with a one-time token pack; pack tokens never expire and any unused pack balance rolls forward. If you exceed your budget, the API returns a 401 until the next reset or until you purchase more tokens.
Connection Limits
The Guavy API has a limit of 10 simultaneous connections and a 120-second timeout per request. We recommend caching responses that don't change frequently to reduce token consumption and improve performance.
