Volmex

https://docs.volmex.finance
Admin
Volmex is a crypto index platform providing implied volatility indices, prime rate benchmarks, and...
Tokens:2,230
Snippets:35
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Query documentation via HTTP GET

Source: https://docs.volmex.finance/llms.txt

Perform a GET request to the documentation index with 'ask' and 'goal' parameters to receive a direct answer.

```http
GET https://docs.volmex.finance/volmex-volmex.finance.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### GET /volmex-volmex.finance.md

Source: https://docs.volmex.finance/llms.txt

Queries the documentation index with a specific question and an optional end goal to receive a tailored response.

```APIDOC
## GET /volmex-volmex.finance.md

### Description
Perform an HTTP GET request on the documentation index to ask a specific question and optionally provide a broader end goal for better context.

### Method
GET

### Endpoint
https://docs.volmex.finance/volmex-volmex.finance.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to be answered.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /history

Source: https://docs.volmex.finance/index-data-api.md

Retrieves historical index data for a specified symbol and resolution within a given time range.

```APIDOC
## GET /history

### Description
Retrieves historical index data for a specified symbol and resolution within a given time range.

### Method
GET

### Endpoint
$REST_URL/history

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The index symbol (e.g., BVIV)
- **resolution** (string) - Required - The data resolution (e.g., D)
- **from** (integer) - Required - Start timestamp
- **to** (integer) - Required - End timestamp

### Request Example
curl --request GET -G \
--url "$REST_URL/history" \
--header 'content-type: application/json' \
-d 'symbol=BVIV' \
-d 'resolution=D' \
-d 'from=1784000000' \
-d 'to=1784315000'
```

--------------------------------

### Implement public WebSocket data stream

Source: https://docs.volmex.finance/index-data-api.md

Connect to the public WebSocket feed to receive index updates every 10 seconds.

```javascript
const socket = io(WS_URL, {transports: ['websocket']});
   socket.on('connect', function () {
     console.log('Connected');
     socket.emit('fetch-indices-messages', {});
     socket.on('indices-messages-stream', (data) => {
       console.log(data);
   });
});
```

--------------------------------

### POST /auth/authorize

Source: https://docs.volmex.finance/index-data-api.md

Authenticates a user to retrieve an access token for private API endpoints.

```APIDOC
## POST /auth/authorize

### Description
Authenticates a user to retrieve an access token for private API endpoints.

### Method
POST

### Endpoint
https://rest-v1.volmex.finance/auth/authorize

### Parameters
#### Request Body
- **login** (string) - Required - API username
- **password** (string) - Required - API password

### Request Example
curl --request POST \
--url 'https://rest-v1.volmex.finance/auth/authorize' \
-d 'login=API_USER&password=API_PASSWORD'
```

--------------------------------

### Query historical index data via REST

Source: https://docs.volmex.finance/index-data-api.md

Use this cURL command to fetch historical index data by specifying the symbol, resolution, and time range.

```bash
curl --request GET -G \
--url "$REST_URL/history" \
--header 'content-type: application/json' \
-d 'symbol=BVIV' \
-d 'resolution=D' \
-d 'from=1784000000' \
-d 'to=1784315000'
```

--------------------------------

### Authenticate for private API access

Source: https://docs.volmex.finance/index-data-api.md

Exchange credentials for an access token required for private WebSocket connections.

```bash
curl --request POST \
--url 'https://rest-v1.volmex.finance/auth/authorize' \
-d 'login=API_USER&password=API_PASSWORD'
```

--------------------------------

### Implement private WebSocket data stream

Source: https://docs.volmex.finance/index-data-api.md

Connect to the private WebSocket feed using a JWT token for higher frequency data updates.

```javascript
const socket = io(WS_URL, {transports: ['websocket'], query: {jwtToken: ACCESS_TOKEN}});
   socket.on('connect', function () {
     console.log('Connected');
     socket.emit('fetch-indices-messages-private', {});
     socket.on('indices-messages-stream-private', (data) => {
       console.log(data);
   });
});
```
Tokens:
Raw