OptionsApi

All URIs are relative to https://api.gateio.ws/api/v4

Method	HTTP request	Description
listOptionsUnderlyings	GET /options/underlyings	List all underlyings
listOptionsExpirations	GET /options/expirations	List all expiration times
listOptionsContracts	GET /options/contracts	List all the contracts with specified underlying and expiration time
getOptionsContract	GET /options/contracts/{contract}	Query specified contract detail
listOptionsSettlements	GET /options/settlements	List settlement history
getOptionsSettlement	GET /options/settlements/{contract}	Get specified contract's settlement
listMyOptionsSettlements	GET /options/my_settlements	List my options settlements
listOptionsOrderBook	GET /options/order_book	Options order book
listOptionsTickers	GET /options/tickers	List tickers of options contracts
listOptionsUnderlyingTickers	GET /options/underlying/tickers/{underlying}	Get underlying ticker
listOptionsCandlesticks	GET /options/candlesticks	Get options candlesticks
listOptionsUnderlyingCandlesticks	GET /options/underlying/candlesticks	Mark price candlesticks of an underlying
listOptionsTrades	GET /options/trades	Options trade history
listOptionsAccount	GET /options/accounts	List options account
listOptionsAccountBook	GET /options/account_book	List account changing history
listOptionsPositions	GET /options/positions	List user's positions of specified underlying
getOptionsPosition	GET /options/positions/{contract}	Get specified contract position
listOptionsPositionClose	GET /options/position_close	List user's liquidation history of specified underlying
listOptionsOrders	GET /options/orders	List options orders
createOptionsOrder	POST /options/orders	Create an options order
cancelOptionsOrders	DELETE /options/orders	Cancel all `open` orders matched
getOptionsOrder	GET /options/orders/{order_id}	Get a single order
cancelOptionsOrder	DELETE /options/orders/{order_id}	Cancel a single order
listMyOptionsTrades	GET /options/my_trades	List personal trading history

listOptionsUnderlyings

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsUnderlyings()

List all underlyings

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
api.listOptionsUnderlyings()
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsUnderlying

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsExpirations

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsExpirations(underlying)

List all expiration times

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
api.listOptionsExpirations(underlying)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> number

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsContracts

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsContracts(underlying, opts)

List all the contracts with specified underlying and expiration time

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
const opts = {
  'expiration': 1636588800 // number | Unix timestamp of the expiration time
};
api.listOptionsContracts(underlying, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]
expiration	number	Unix timestamp of the expiration time	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsContract

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getOptionsContract

Promise<{ response: http.IncomingMessage; body: OptionsContract; }> getOptionsContract(contract)

Query specified contract detail

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const contract = "BTC_USDT-20211130-65000-C"; // string | 
api.getOptionsContract(contract)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
contract	string		[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: OptionsContract; }> OptionsContract

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsSettlements

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsSettlements(underlying, opts)

List settlement history

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
const opts = {
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'offset': 0, // number | List offset, starting from 0
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332 // number | End timestamp
};
api.listOptionsSettlements(underlying, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
offset	number	List offset, starting from 0	[optional] [default to 0]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsSettlement

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getOptionsSettlement

Promise<{ response: http.IncomingMessage; body: OptionsSettlement; }> getOptionsSettlement(contract, underlying, at)

Get specified contract's settlement

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const contract = "BTC_USDT-20211130-65000-C"; // string | 
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
const at = 56; // number | 
api.getOptionsSettlement(contract, underlying, at)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
contract	string		[default to undefined]
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]
at	number		[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: OptionsSettlement; }> OptionsSettlement

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listMyOptionsSettlements

Promise<{ response: http.IncomingMessage; body: Array; }> listMyOptionsSettlements(underlying, opts)

List my options settlements

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
const opts = {
  'contract': "BTC_USDT-20210916-5000-C", // string | Options contract name
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'offset': 0, // number | List offset, starting from 0
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332 // number | End timestamp
};
api.listMyOptionsSettlements(underlying, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]
contract	string	Options contract name	[optional] [default to undefined]
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
offset	number	List offset, starting from 0	[optional] [default to 0]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsMySettlements

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsOrderBook

Promise<{ response: http.IncomingMessage; body: FuturesOrderBook; }> listOptionsOrderBook(contract, opts)

Options order book

Bids will be sorted by price from high to low, while asks sorted reversely

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const contract = "BTC_USDT-20210916-5000-C"; // string | Options contract name
const opts = {
  'interval': '0', // '0' | '0.1' | '0.01' | Order depth. 0 means no aggregation is applied. default to 0
  'limit': 10, // number | Maximum number of order depth data in asks or bids
  'withId': false // boolean | Whether the order book update ID will be returned. This ID increases by 1 on every order book update
};
api.listOptionsOrderBook(contract, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
contract	string	Options contract name	[default to undefined]
interval	Interval	Order depth. 0 means no aggregation is applied. default to 0	[optional] [default to '0']
limit	number	Maximum number of order depth data in asks or bids	[optional] [default to 10]
withId	boolean	Whether the order book update ID will be returned. This ID increases by 1 on every order book update	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: FuturesOrderBook; }> FuturesOrderBook

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsTickers

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsTickers(underlying)

List tickers of options contracts

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
api.listOptionsTickers(underlying)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsTicker

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsUnderlyingTickers

Promise<{ response: http.IncomingMessage; body: OptionsUnderlyingTicker; }> listOptionsUnderlyingTickers(underlying)

Get underlying ticker

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying
api.listOptionsUnderlyingTickers(underlying)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying	[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: OptionsUnderlyingTicker; }> OptionsUnderlyingTicker

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsCandlesticks

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsCandlesticks(contract, opts)

Get options candlesticks

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const contract = "BTC_USDT-20210916-5000-C"; // string | Options contract name
const opts = {
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332, // number | End timestamp
  'interval': '5m' // '1m' | '5m' | '15m' | '30m' | '1h' | Interval time between data points
};
api.listOptionsCandlesticks(contract, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
contract	string	Options contract name	[default to undefined]
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]
interval	Interval	Interval time between data points	[optional] [default to '5m']

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsCandlestick

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsUnderlyingCandlesticks

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsUnderlyingCandlesticks(underlying, opts)

Mark price candlesticks of an underlying

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
const opts = {
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332, // number | End timestamp
  'interval': '5m' // '1m' | '5m' | '15m' | '30m' | '1h' | Interval time between data points
};
api.listOptionsUnderlyingCandlesticks(underlying, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]
interval	Interval	Interval time between data points	[optional] [default to '5m']

Return type

Promise<{ response: AxiosResponse; body: Array; }> FuturesCandlestick

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsTrades

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsTrades(opts)

Options trade history

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"

const api = new GateApi.OptionsApi(client);
const opts = {
  'contract': "BTC_USDT-20210916-5000-C", // string | Options contract name
  'type': "1546935600", // string | `C` is call, while `P` is put
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'offset': 0, // number | List offset, starting from 0
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332 // number | End timestamp
};
api.listOptionsTrades(opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
contract	string	Options contract name	[optional] [default to undefined]
type	string	`C` is call, while `P` is put	[optional] [default to undefined]
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
offset	number	List offset, starting from 0	[optional] [default to 0]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> FuturesTrade

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsAccount

Promise<{ response: http.IncomingMessage; body: OptionsAccount; }> listOptionsAccount()

List options account

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
api.listOptionsAccount()
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

Promise<{ response: AxiosResponse; body: OptionsAccount; }> OptionsAccount

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsAccountBook

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsAccountBook(opts)

List account changing history

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const opts = {
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'offset': 0, // number | List offset, starting from 0
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332, // number | End timestamp
  'type': "dnw" // 'dnw' | 'prem' | 'fee' | 'refr' | 'set' | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL 
};
api.listOptionsAccountBook(opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
offset	number	List offset, starting from 0	[optional] [default to 0]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]
type	Type	Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsAccountBook

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsPositions

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsPositions(opts)

List user's positions of specified underlying

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const opts = {
  'underlying': "BTC_USDT" // string | Underlying
};
api.listOptionsPositions(opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsPosition

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

getOptionsPosition

Promise<{ response: http.IncomingMessage; body: OptionsPosition; }> getOptionsPosition(contract)

Get specified contract position

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const contract = "BTC_USDT-20211130-65000-C"; // string | 
api.getOptionsPosition(contract)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
contract	string		[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: OptionsPosition; }> OptionsPosition

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsPositionClose

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsPositionClose(underlying, opts)

List user's liquidation history of specified underlying

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
const opts = {
  'contract': "BTC_USDT-20210916-5000-C" // string | Options contract name
};
api.listOptionsPositionClose(underlying, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]
contract	string	Options contract name	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsPositionClose

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOptionsOrders

Promise<{ response: http.IncomingMessage; body: Array; }> listOptionsOrders(status, opts)

List options orders

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const status = "open"; // 'open' | 'finished' | Only list the orders with this status
const opts = {
  'contract': "BTC_USDT-20210916-5000-C", // string | Options contract name
  'underlying': "BTC_USDT", // string | Underlying
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'offset': 0, // number | List offset, starting from 0
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332 // number | End timestamp
};
api.listOptionsOrders(status, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
status	Status	Only list the orders with this status	[default to undefined]
contract	string	Options contract name	[optional] [default to undefined]
underlying	string	Underlying	[optional] [default to undefined]
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
offset	number	List offset, starting from 0	[optional] [default to 0]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsOrder

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

createOptionsOrder

Promise<{ response: http.IncomingMessage; body: OptionsOrder; }> createOptionsOrder(optionsOrder)

Create an options order

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const optionsOrder = new OptionsOrder(); // OptionsOrder | 
api.createOptionsOrder(optionsOrder)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
optionsOrder	OptionsOrder

Return type

Promise<{ response: AxiosResponse; body: OptionsOrder; }> OptionsOrder

Authorization

apiv4

HTTP request headers

Content-Type: application/json
Accept: application/json

cancelOptionsOrders

Promise<{ response: http.IncomingMessage; body: Array; }> cancelOptionsOrders(opts)

Cancel all `open` orders matched

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const opts = {
  'contract': "BTC_USDT-20210916-5000-C", // string | Options contract name
  'underlying': "BTC_USDT", // string | Underlying
  'side': "ask" // 'ask' | 'bid' | All bids or asks. Both included if not specified
};
api.cancelOptionsOrders(opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
contract	string	Options contract name	[optional] [default to undefined]
underlying	string	Underlying	[optional] [default to undefined]
side	Side	All bids or asks. Both included if not specified	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsOrder

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

getOptionsOrder

Promise<{ response: http.IncomingMessage; body: OptionsOrder; }> getOptionsOrder(orderId)

Get a single order

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const orderId = 12345; // number | Order ID returned on successful order creation
api.getOptionsOrder(orderId)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
orderId	number	Order ID returned on successful order creation	[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: OptionsOrder; }> OptionsOrder

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

cancelOptionsOrder

Promise<{ response: http.IncomingMessage; body: OptionsOrder; }> cancelOptionsOrder(orderId)

Cancel a single order

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const orderId = 12345; // number | Order ID returned on successful order creation
api.cancelOptionsOrder(orderId)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
orderId	number	Order ID returned on successful order creation	[default to undefined]

Return type

Promise<{ response: AxiosResponse; body: OptionsOrder; }> OptionsOrder

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

listMyOptionsTrades

Promise<{ response: http.IncomingMessage; body: Array; }> listMyOptionsTrades(underlying, opts)

List personal trading history

Example

const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");

const api = new GateApi.OptionsApi(client);
const underlying = "BTC_USDT"; // string | Underlying (Obtained by listing underlying endpoint)
const opts = {
  'contract': "BTC_USDT-20210916-5000-C", // string | Options contract name
  'limit': 100, // number | Maximum number of records to be returned in a single list
  'offset': 0, // number | List offset, starting from 0
  'from': 1547706332, // number | Start timestamp
  'to': 1547706332 // number | End timestamp
};
api.listMyOptionsTrades(underlying, opts)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

Parameters

Name	Type	Description	Notes
underlying	string	Underlying (Obtained by listing underlying endpoint)	[default to undefined]
contract	string	Options contract name	[optional] [default to undefined]
limit	number	Maximum number of records to be returned in a single list	[optional] [default to 100]
offset	number	List offset, starting from 0	[optional] [default to 0]
from	number	Start timestamp	[optional] [default to undefined]
to	number	End timestamp	[optional] [default to undefined]

Return type

Promise<{ response: AxiosResponse; body: Array; }> OptionsMyTrade

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

OptionsApi.md

Latest commit

History

OptionsApi.md

File metadata and controls

OptionsApi

listOptionsUnderlyings

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsExpirations

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsContracts

Example

Parameters

Return type

Authorization

HTTP request headers

getOptionsContract

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsSettlements

Example

Parameters

Return type

Authorization

HTTP request headers

getOptionsSettlement

Example

Parameters

Return type

Authorization

HTTP request headers

listMyOptionsSettlements

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsOrderBook

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsTickers

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsUnderlyingTickers

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsCandlesticks

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsUnderlyingCandlesticks

Example

Parameters

Return type

Authorization

HTTP request headers

listOptionsTrades