@serviceru/bybit_api v0.2.10

bybit_api

BybitApi - JavaScript client for bybit_api

REST API for the Bybit Exchange. Base URI: https://api.bybit.com

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.2.10
• Package version: 0.2.10
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install bybit_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your bybit_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var BybitApi = require('bybit_api');

var defaultClient = BybitApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['api_key'] = "Token"

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix['sign'] = "Token"

// Configure API key authorization: timestamp
var timestamp = defaultClient.authentications['timestamp'];
timestamp.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//timestamp.apiKeyPrefix['timestamp'] = "Token"

var api = new BybitApi.APIkeyApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.aPIkeyInfo(callback);

Documentation for API Endpoints

All URIs are relative to https://api.bybit.com

Documentation for Models

• BybitApi.APIKeyBase
• BybitApi.APIKeyInfo
• BybitApi.AccountRatio
• BybitApi.AccountRatioInfo
• BybitApi.Announcement
• BybitApi.AnnouncementInfo
• BybitApi.BigDeal
• BybitApi.BigDealInfo
• BybitApi.ClosedPnlBase
• BybitApi.ClosedPnlInfo
• BybitApi.ConditionalCancelAllBase
• BybitApi.ConditionalCancelAllRes
• BybitApi.ConditionalOrdersRes
• BybitApi.ConditionalOrdersResBase
• BybitApi.ConditionalRes
• BybitApi.ExchangeOrderList
• BybitApi.ExchangeOrderListBase
• BybitApi.ExtFields
• BybitApi.FundRecordBase
• BybitApi.FundingFeeBase
• BybitApi.FundingFeeRes
• BybitApi.FundingPredicted
• BybitApi.FundingPredictedBase
• BybitApi.FundingRate
• BybitApi.FundingRateBase
• BybitApi.FundingRecords
• BybitApi.GetRiskLimitRes
• BybitApi.KlineBase
• BybitApi.KlineRes
• BybitApi.LCPInfo
• BybitApi.LCPInfoBase
• BybitApi.Leverage
• BybitApi.LeverageInfo
• BybitApi.LeverageResult
• BybitApi.LinearCancelOrderResult
• BybitApi.LinearCancelOrderResultBase
• BybitApi.LinearCancelStopOrderResult
• BybitApi.LinearCancelStopOrderResultBase
• BybitApi.LinearClosePnlRecordsResponse
• BybitApi.LinearClosedPnlRecordResult
• BybitApi.LinearCreateOrderResult
• BybitApi.LinearCreateOrderResultBase
• BybitApi.LinearCreateStopOrderResult
• BybitApi.LinearCreateStopOrderResultBase
• BybitApi.LinearFundingPredicted
• BybitApi.LinearFundingPredictedBase
• BybitApi.LinearKlineResp
• BybitApi.LinearKlineRespBase
• BybitApi.LinearListOrderResult
• BybitApi.LinearListStopOrderResult
• BybitApi.LinearOrderCancelAllBase
• BybitApi.LinearOrderRecordsResponse
• BybitApi.LinearOrderRecordsResponseBase
• BybitApi.LinearOrderReplace
• BybitApi.LinearPositionListResult
• BybitApi.LinearPositionListResultBase
• BybitApi.LinearPrevFundingRateResp
• BybitApi.LinearPrevFundingRateRespBase
• BybitApi.LinearPrevFundingResp
• BybitApi.LinearPrevFundingRespBase
• BybitApi.LinearRecentTradingRecordResp
• BybitApi.LinearRecentTradingRecordRespBase
• BybitApi.LinearRiskLimitResp
• BybitApi.LinearRiskLimitRespBase
• BybitApi.LinearSearchOrderResult
• BybitApi.LinearSearchOrderResultBase
• BybitApi.LinearSearchStopOrderResult
• BybitApi.LinearSearchStopOrderResultBase
• BybitApi.LinearSetLeverageResult
• BybitApi.LinearSetMarginResult
• BybitApi.LinearSetMarginResultBase
• BybitApi.LinearSetTradingStopResult
• BybitApi.LinearStopOrderCancelAllBase
• BybitApi.LinearStopOrderRecordsResponse
• BybitApi.LinearStopOrderRecordsResponseBase
• BybitApi.LinearStopOrderReplace
• BybitApi.LinearSwitchIsolatedResult
• BybitApi.LinearSwitchModeResult
• BybitApi.LinearTradeRecordItem
• BybitApi.LinearTradeRecordsResponse
• BybitApi.LiqRecords
• BybitApi.LiqRecordsInfo
• BybitApi.LotSizeFilter
• BybitApi.MarkPriceKlineBase
• BybitApi.MarkPriceKlineInfo
• BybitApi.OderBookRes
• BybitApi.OpenInterest
• BybitApi.OpenInterestInfo
• BybitApi.OrderBookBase
• BybitApi.OrderCancelAllBase
• BybitApi.OrderCancelAllRes
• BybitApi.OrderCancelBase
• BybitApi.OrderIdRes
• BybitApi.OrderRes
• BybitApi.OrderResBase
• BybitApi.Position
• BybitApi.PositionInfo
• BybitApi.PriceFilter
• BybitApi.QueryOrderBase
• BybitApi.QueryOrderRes
• BybitApi.ReplaceConditionalBase
• BybitApi.ReplaceOrderBase
• BybitApi.RiskIDRes
• BybitApi.RiskLimitBase
• BybitApi.RiskLimitRes
• BybitApi.ServerTime
• BybitApi.SetRiskLimitBase
• BybitApi.StopOrderOrdersResBase
• BybitApi.SymbolInfo
• BybitApi.SymbolInfoBase
• BybitApi.SymbolTickInfo
• BybitApi.Symbols
• BybitApi.TradeRecords
• BybitApi.TradeRecordsBase
• BybitApi.TradeRecordsInfo
• BybitApi.TradingRecords
• BybitApi.TradingRecordsInfo
• BybitApi.TradingStopBase
• BybitApi.TradingStopRes
• BybitApi.V2CancelOrderBase
• BybitApi.V2ConditionalBase
• BybitApi.V2ConditionalListRes
• BybitApi.V2ConditionalRes
• BybitApi.V2OrderListBase
• BybitApi.V2OrderListData
• BybitApi.V2OrderRes
• BybitApi.WalletBalance
• BybitApi.WalletBalanceBase
• BybitApi.WithdrawRecords
• BybitApi.WithdrawResBase

Documentation for Authorization

apiKey

• Type: API key
• API key parameter name: api_key
• Location: URL query string

apiSignature

• Type: API key
• API key parameter name: sign
• Location: URL query string

timestamp

• Type: API key
• API key parameter name: timestamp
• Location: URL query string