Trades
Get Backtest Summary
·
/api/v1/trades/get-backtest-summary
Get Backtest Summary
This endpoint provides a high-level performance overview of historical backtest trades made by the Guavy simulator for a given instrument and trade strategy.
Attributes
symbol
string
Required
The symbol of the instrument to perform a backtest on.
strategy
string
Required
The risk profile to use for the backtest. Can be 'aggressive' or 'conservative'.
years
integer
Specifies the maximum number of years of historical data to include in the backtest (default is 2).
API Request
Example Request with cURL
curl \
--request GET \
--url 'https://data.guavy.com/api/v1/trades/get-backtest-summary/<symbol>/<strategy>?years=<integer>' \
--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/v1/trades/get-backtest-summary/ADA/conservative?years=3
{
"annualized_return": 8.39305350576814,
"average_loss": -0.048215533080984294,
"average_loss_percent": -2.24,
"average_profit": 0.0649898555261976,
"average_profit_percent": 13.03,
"average_trade_duration": 3.0454545454545454,
"backtest_duration": 961,
"buy_and_hold_profit_percent": -1.74,
"end_date": "2026-01-19",
"final_value": 1220.9787512066625,
"initial_investment": 1000,
"peak_loss": -0.027103850041040545,
"peak_profit": 0.16192495827571957,
"profit_percent": 22.1,
"profitable_trade_percent": 22.73,
"profitable_trades": 5,
"start_date": "2023-06-03",
"total_profit": 220.97875120666254,
"total_trades": 22,
"unprofitable_trades": 17
}
Response Object
annualized_return
float
The expected annualized return based on total profit and backtest duration.
average_loss
float
The average loss per unprofitable trade.
average_loss_percent
float
The average loss per unprofitable trade, as a percentage.
average_profit
float
The average gain per profitable trade.
average_profit_percent
float
The average gain per profitable trade, as a percentage.
average_trade_duration
float
The average length of a trade, in days.
backtest_duration
integer
The length of historical data provided to the backtest, in days.
buy_and_hold_profit_percent
float
Profit gains, as a percentage, if the Guavy simulator had bought and held the instrument for the duration of the backtest.
end_date
string
The end date of the backtest simulation.
final_value
float
The final value of the investment after all simulated trades.
initial_investment
integer
The initial value invested in the instrument.
peak_loss
float
The greatest loss made by a singular trade.
peak_profit
float
The highest profit made by a singular trade.
profit_percent
float
The total profit made from the simulated trades, as a percentage.
profitable_trade_percent
float
The percentage of trades that made a profit.
profitable_trades
integer
The number of trades that made a profit.
start_date
string
The start date of the backtest simulation.
total_profit
float
The total profit made from the simulated trades.
total_trades
integer
The total number of trades made in the simulation.
unprofitable_trades
integer
The number of unprofitable trades made in the simulation.
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.
| Endpoint | Token Cost |
|---|---|
| GET /api/v1/ping | 1 |
| GET /api/v1/instruments/list-symbols | 1 |
| GET /api/v1/instruments/search-instruments/:query | 2 |
| GET /api/v1/instruments/get-detail/:symbol | 5 |
| GET /api/v1/instruments/scorecard/:symbol | 10 |
| GET /api/v1/newsroom/get-market-summary | 3 |
| GET /api/v1/newsroom/get-article/:id | 3 |
| GET /api/v1/newsroom/get-recent-briefs/:symbol | 3 – 8 (scales with limit) |
| GET /api/v1/newsroom/search-briefs/:symbol | 3 – 8 (scales with limit) |
| GET /api/v1/newsroom/get-instrument-analysis/:symbol | 10 |
| GET /api/v1/trades/get-recent-buys | 3 |
| GET /api/v1/trades/get-recent-sells | 3 |
| GET /api/v1/trades/get-recommendations | 5 |
| GET /api/v1/trades/get-current-action/:symbol/:strategy | 5 |
| GET /api/v1/trades/get-trend-history/:symbol/:limit | 5 – 15 (scales with limit) |
| GET /api/v1/trades/get-backtest-history/:symbol/:strategy | 8 – 20 (scales with years) |
| GET /api/v1/trades/get-backtest-summary/:symbol/:strategy | 8 – 20 (scales with years) |
| GET /api/v1/sentiment/get-sentiment-history/:symbol | 3 – 12 (scales with limit) |
| GET /api/v1/technical-analysis/get-price-history/:symbol | 5 |
| GET /api/v1/technical-analysis/get-indicators/:symbol | 8 |
Account Limits
Each plan includes a monthly token budget: 3,000 for Sandbox, 250,000 for Quant, and 2,000,000 for Commercial. You can top up at any time with a one-time token pack — unused tokens roll over every month. If you exceed your budget, the API returns a 403 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.
Was this
helpful?
Prev
Next