# Sandmark API

> Volatility data and options backtesting for crypto, by Sandmark.

- [Overview](https://docs.sandmark.com/index.md): Sandmark Volatility API
- [Quickstart](https://docs.sandmark.com/quickstart.md): From API key to your first volatility series in under five minutes.
- [Authentication](https://docs.sandmark.com/authentication.md): Every request is authenticated with an API key sent in a header.
- [History window](https://docs.sandmark.com/concepts/history-window.md): How far back you can read is set by your billing plan.
- [Continuous implied volatility](https://docs.sandmark.com/concepts/implied-volatility.md): What one point in the IV series means, and how it is built.
- [Realised volatility](https://docs.sandmark.com/concepts/realized-volatility.md): How much the underlying actually moved, on the same scale as implied vol.
- [Implied vs realised](https://docs.sandmark.com/guides/iv-vs-rv.md): Join IV and RV into one frame and read the variance premium.
- [Paging through history](https://docs.sandmark.com/guides/paging.md): Pull a full history window in pages of up to 5,000 rows.
- [Errors and limits](https://docs.sandmark.com/errors-and-limits.md): Status codes, error bodies and the rate limit.
- [Backtesting](https://docs.sandmark.com/backtesting/overview.md): Test an options strategy on years of crypto derivatives history with one request.
- [Backtesting quickstart](https://docs.sandmark.com/backtesting/quickstart.md): Backtest a covered call and read the result.
- [Strategy specification](https://docs.sandmark.com/backtesting/strategy-spec.md): Every field of a backtest request, and how the engine reads it.
- [Reading the result](https://docs.sandmark.com/backtesting/results.md): Statistics, the equity curve, positions, trades and warnings.
- [Recipes](https://docs.sandmark.com/backtesting/recipes.md): Five tested strategies to copy, run and adapt.
- [Plans and limits](https://docs.sandmark.com/backtesting/plans-and-limits.md): Backtest lookback by plan, rate limit and run time.
- [List assets](https://docs.sandmark.com/api-reference/list-assets.md): Every underlying you can query. Use these values for the `asset` parameter.
- [List frequencies](https://docs.sandmark.com/api-reference/list-frequencies.md): The sampling frequencies stored for the timeseries endpoints.
- [List expiries](https://docs.sandmark.com/api-reference/list-expiries.md): Listed option or future expiries for an asset. By default only monthly expiries (last Friday of the month) are returned; set `last_friday_only=false` for weeklies and dailies, and `active_only=true` to drop expiries that have already settled.
- [Implied volatility](https://docs.sandmark.com/api-reference/implied-volatility.md): Continuous constant-maturity implied volatility for one tenor, delta and option type. Each point is interpolated in total variance between the two listed expiries that bracket the tenor, so the series never jumps on an expiry roll. Values are decimal (0.37 = 37 vol points).
- [Realised volatility](https://docs.sandmark.com/api-reference/realized-volatility.md): Annualised realised volatility of the underlying index over a rolling lookback. `lookback_days=30` is 30-day realised vol, directly comparable with 1m implied vol. Values are decimal.
- [Run a backtest](https://docs.sandmark.com/api-reference/run-backtest.md): Run an options strategy over history and get back the equity curve, every trade, the positions they belong to and the performance statistics.

## OpenAPI Specs

- [backtest-openapi](/api-reference/backtest-openapi.json)
- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.