The Graph API

The Graph API provides detailed information about various financial activities. With the use of this API, you can retrieve data about open interests, deposits, withdraws, open positions, open orders, portfolios, closed positions, and trade activities.

Base URL

The base URL for all the API endpoints is https://api.vela.exchange/graph. Example Request Base:

GET https://api.vela.exchange/graph/{ENDPOINT}/{chainId}/{address}

API Endpoints

This endpoint retrieves open interests for a given chain id.

GET/graph/open_interests/{chainId}

Path parameters

chainId*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/open_interests/{chainId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

This endpoint retrieves deposits for a given chain id and address.

GET/graph/deposits/{chainId}/{address}

Path parameters

chainId*string

address*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/deposits/{chainId}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

This endpoint retrieves withdraws for a given chain id and address.

GET/graph/withdraws/{chainId}/{address}

Path parameters

chainId*string

address*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/withdraws/{chainId}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

This endpoint retrieves open positions for a given chain id and address.

GET/graph/open_positions/{chainId}/{address}

Path parameters

chainId*string

address*string

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/open_positions/{chainId}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

This endpoint retrieves open positions for a given chain id and address.

GET/graph/open_orders/{chainId}/{address}

Path parameters

chainId*string

address*string

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/open_orders/{chainId}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

This endpoint retrieves portfolios for a given chain id and address.

GET/graph/portfolios/{chainId}/{address}

Path parameters

chainId*string

address*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/portfolios/{chainId}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

This endpoint retrieves closed positions for a given chain id and address.

GET/graph/closed_positions/{chainId}/{address}

Path parameters

chainId*string

address*string

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/closed_positions/{chainId}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

This endpoint retrieves trade activities for a given chain id and address.

GET/graph/trade_activities/{chainId}/{address}

Path parameters

chainId*string

address*string

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/graph/trade_activities/{chainId}/{address}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

An example of a request:

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.vela.exchange/graph/deposits/42161/0xYourEthereumAddress',  // Update with your chainId and address
  headers: { }
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Errors

Our API uses conventional HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicates an error from the client's side, and 5xx indicates an error from the server's side.