Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

FAQ

Frequently asked questions about the BaseVol API

General

What trading modes are supported via the API?

The API supports 1-Hour and 1-Day option trading. Each mode has its own set of endpoints under /orders/1hour/ and /orders/1day/.

What is an epoch?

An epoch is a unique identifier for a trading round. Each epoch represents a time-bounded trading period. Use the /rounds/{mode}/current endpoint to get the current epoch.

What is the base URL for the API?

https://api.basevol.com/api/v1

Authentication

How do I get an API key?

Navigate to Settings > API Keys on the BaseVol dashboard, click Create API Key, and configure the name, permissions, and optional IP whitelist.

Can I use multiple API keys?

Yes. The number of keys depends on your tier: Basic allows 3, Pro allows 10, and Enterprise allows 50 keys.

How do I rotate my API key?

Use the Regenerate option on the dashboard. This creates a new key and immediately invalidates the old one.

What happens if my API key expires?

Expired keys return a 401 error with the code AUTH_EXPIRED_API_KEY. Create a new key or set a longer expiration when creating keys.

Trading

What are the valid values for position?

The position field accepts "over" or "under":

  • over — betting realized volatility will be above the strike

  • under — betting realized volatility will be below the strike

What is the valid range for price?

The price field must be between 1 and 99 (inclusive). This represents the premium per unit.

What order types are supported?

  • "market" — executes immediately at the best available price

  • "limit" — executes only at the specified price or better

Can I cancel an order after the round starts?

This depends on the order status. Only open (unfilled) orders can be cancelled. Filled positions must be closed using the close-position endpoint.

Rate Limits

How do I check my current rate limit usage?

Inspect the response headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

How do I upgrade my rate limit tier?

Contact the BaseVol team via Discord to request a tier upgrade.

Why am I getting 429 errors?

A 429 response means you have exceeded your rate limit. Check the Retry-After header for the number of seconds to wait before retrying. Consider implementing exponential backoff.

Errors

What does ORDER_FAILED mean?

ORDER_FAILED indicates a server-side error during order placement. Retry the request after a short delay. If the error persists, contact support with the requestId from the error response.

What does ORDER_INSUFFICIENT_BALANCE mean?

Your account does not have enough USDC to cover the order. Check your balance with GET /api/v1/account/balance and deposit more funds if needed.

Support

If you have any inquiries, please reach out to our community.

PreviousChangelogNextRisks & Disclosure

Last updated