TypeScript NodeJS client for gate-api.

APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 4.18.4
• Package version:
• Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen For more information, please visit https://www.gate.io/page/contacts

Environment

• Node.js

Language level

• ES2017

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference) This package is targeting Node.js applications only, because it's not safe to store API secret in browser. gateapi-js can be used in browser but with public endpoints only.

Trying our best to follow the semantic versioning, while enjoying recent features provided by programming language and libraries, from 4.15.2, one major versioning difference will be introduced:

If extra code rewrite is required when you upgrade the SDK, such as:

• some outdated programming language version support is dropped
• API method signature has breaking changes.

the MAJOR version will be incremented, but the MINOR and PATCH version are still following REST API's instead of resetting to 0, so that you can recognize it has some breaking changes, but still getting the idea of from which REST API version the change is introduced.

For example, the previous REST API and SDK version are both 4.14.0. But if we decide to introduce some breaking changes in SDK along with REST API 4.15.2 upgrade, then the version of next SDK release will be 5.15.2(the MAJOR version is incremented to denote breaking changes, but the MINOR and PATCH version are identical to REST API's instead of resetting them to 0)

If MAJOR version is incremented, make sure you read the release note on Releases page

To build and compile the typescript sources to javascript use:

npm install
npm run build

To use the library locally, first install the dependencies by changing into the directory containing package.json (and this README). Then run:

npm install

Next, link it globally in npm with the following:

npm link

Finally, switch to the directory you want to use your gate-api from, and run:

npm link gate-api

You should now be able to require('gate-api') in javascript files from the directory you ran the last command above from.

If the library is hosted at a git repository, e.g. https://github.com/gateio/gateapi-nodejs then install it via:

npm install gateio/gateapi-nodejs --save

Please follow the installation instruction and execute the following TypeScript code:

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.DeliveryApi(client);
const settle = "usdt"; // 'usdt' | Settle currency
api.listDeliveryContracts(settle)
   .then(value => console.log('API called successfully. Returned data: ', value.body),
         error => console.error(error));

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

• BatchOrder
• CancelOrder
• CancelOrderResult
• Contract
• ContractStat
• Currency
• CurrencyPair
• DeliveryContract
• DeliverySettlement
• DepositAddress
• FundingAccount
• FundingBookItem
• FundingRateRecord
• FuturesAccount
• FuturesAccountBook
• FuturesCandlestick
• FuturesInitialOrder
• FuturesLiquidate
• FuturesOrder
• FuturesOrderBook
• FuturesOrderBookItem
• FuturesPriceTrigger
• FuturesPriceTriggeredOrder
• FuturesTicker
• FuturesTrade
• InsuranceRecord
• LedgerRecord
• Loan
• LoanPatch
• LoanRecord
• MarginAccount
• MarginAccountBook
• MarginAccountCurrency
• MarginCurrencyPair
• MyFuturesTrade
• OpenOrders
• Order
• OrderBook
• Position
• PositionClose
• PositionCloseOrder
• RepayRequest
• Repayment
• SpotAccount
• SubAccountBalance
• SubAccountTransfer
• Ticker
• Trade
• TradeFee
• Transfer
• TriggerOrderResponse
• WithdrawStatus

Authentication schemes defined for the API:

• Type: Gate APIv4

https://www.gate.io/docs/apiv4/en/index.html#apiv4-signed-request-requirements