Skip to content

Wapweb/gateapi-php

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

92 Commits
docs
docs
 
 
src
src
 
 
.gitignore
.gitignore
 
 
.php-cs-fixer.php
.php-cs-fixer.php
 
 
.php_cs
.php_cs
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
composer.lock
composer.lock
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

GateApi

Welcome to Gate.io 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 PHP package is automatically generated by the OpenAPI Generator project:

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

Versioning

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

Requirements

PHP 7.1 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
    "require": {
        "gateio/gateapi-php": "@stable"
    }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

require_once('/path/to/GateApi/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new GateApi\Api\DeliveryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$settle = 'usdt'; // string | Settle currency

try {
    $result = $apiInstance->listDeliveryContracts($settle);
    print_r($result);
} catch (GateApi\GateApiException $e) {
    echo "Gate API Exception: label: {$e->getLabel()}, message: {$e->getMessage()}" . PHP_EOL;
} catch (Exception $e) {
    echo 'Exception when calling DeliveryApi->listDeliveryContracts: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

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

Class Method HTTP request Description
DeliveryApi listDeliveryContracts GET /delivery/{settle}/contracts List all futures contracts
DeliveryApi getDeliveryContract GET /delivery/{settle}/contracts/{contract} Get a single contract
DeliveryApi listDeliveryOrderBook GET /delivery/{settle}/order_book Futures order book
DeliveryApi listDeliveryTrades GET /delivery/{settle}/trades Futures trading history
DeliveryApi listDeliveryCandlesticks GET /delivery/{settle}/candlesticks Get futures candlesticks
DeliveryApi listDeliveryTickers GET /delivery/{settle}/tickers List futures tickers
DeliveryApi listDeliveryInsuranceLedger GET /delivery/{settle}/insurance Futures insurance balance history
DeliveryApi listDeliveryAccounts GET /delivery/{settle}/accounts Query futures account
DeliveryApi listDeliveryAccountBook GET /delivery/{settle}/account_book Query account book
DeliveryApi listDeliveryPositions GET /delivery/{settle}/positions List all positions of a user
DeliveryApi getDeliveryPosition GET /delivery/{settle}/positions/{contract} Get single position
DeliveryApi updateDeliveryPositionMargin POST /delivery/{settle}/positions/{contract}/margin Update position margin
DeliveryApi updateDeliveryPositionLeverage POST /delivery/{settle}/positions/{contract}/leverage Update position leverage
DeliveryApi updateDeliveryPositionRiskLimit POST /delivery/{settle}/positions/{contract}/risk_limit Update position risk limit
DeliveryApi listDeliveryOrders GET /delivery/{settle}/orders List futures orders
DeliveryApi createDeliveryOrder POST /delivery/{settle}/orders Create a futures order
DeliveryApi cancelDeliveryOrders DELETE /delivery/{settle}/orders Cancel all `open` orders matched
DeliveryApi getDeliveryOrder GET /delivery/{settle}/orders/{order_id} Get a single order
DeliveryApi cancelDeliveryOrder DELETE /delivery/{settle}/orders/{order_id} Cancel a single order
DeliveryApi getMyDeliveryTrades GET /delivery/{settle}/my_trades List personal trading history
DeliveryApi listDeliveryPositionClose GET /delivery/{settle}/position_close List position close history
DeliveryApi listDeliveryLiquidates GET /delivery/{settle}/liquidates List liquidation history
DeliveryApi listDeliverySettlements GET /delivery/{settle}/settlements List settlement history
DeliveryApi listPriceTriggeredDeliveryOrders GET /delivery/{settle}/price_orders List all auto orders
DeliveryApi createPriceTriggeredDeliveryOrder POST /delivery/{settle}/price_orders Create a price-triggered order
DeliveryApi cancelPriceTriggeredDeliveryOrderList DELETE /delivery/{settle}/price_orders Cancel all open orders
DeliveryApi getPriceTriggeredDeliveryOrder GET /delivery/{settle}/price_orders/{order_id} Get a price-triggered order
DeliveryApi cancelPriceTriggeredDeliveryOrder DELETE /delivery/{settle}/price_orders/{order_id} cancel a price-triggered order
FlashSwapApi listFlashSwapCurrencies GET /flash_swap/currencies List all supported currencies in flash swap
FlashSwapApi listFlashSwapOrders GET /flash_swap/orders List all flash swap orders
FlashSwapApi createFlashSwapOrder POST /flash_swap/orders Create a flash swap order
FlashSwapApi getFlashSwapOrder GET /flash_swap/orders/{order_id} Get a single flash swap order's detail
FlashSwapApi previewFlashSwapOrder POST /flash_swap/orders/preview Initiate a flash swap order preview
FuturesApi listFuturesContracts GET /futures/{settle}/contracts List all futures contracts
FuturesApi getFuturesContract GET /futures/{settle}/contracts/{contract} Get a single contract
FuturesApi listFuturesOrderBook GET /futures/{settle}/order_book Futures order book
FuturesApi listFuturesTrades GET /futures/{settle}/trades Futures trading history
FuturesApi listFuturesCandlesticks GET /futures/{settle}/candlesticks Get futures candlesticks
FuturesApi listFuturesPremiumIndex GET /futures/{settle}/premium_index Premium Index K-Line
FuturesApi listFuturesTickers GET /futures/{settle}/tickers List futures tickers
FuturesApi listFuturesFundingRateHistory GET /futures/{settle}/funding_rate Funding rate history
FuturesApi listFuturesInsuranceLedger GET /futures/{settle}/insurance Futures insurance balance history
FuturesApi listContractStats GET /futures/{settle}/contract_stats Futures stats
FuturesApi getIndexConstituents GET /futures/{settle}/index_constituents/{index} Get index constituents
FuturesApi listLiquidatedOrders GET /futures/{settle}/liq_orders Retrieve liquidation history
FuturesApi listFuturesAccounts GET /futures/{settle}/accounts Query futures account
FuturesApi listFuturesAccountBook GET /futures/{settle}/account_book Query account book
FuturesApi listPositions GET /futures/{settle}/positions List all positions of a user
FuturesApi getPosition GET /futures/{settle}/positions/{contract} Get single position
FuturesApi updatePositionMargin POST /futures/{settle}/positions/{contract}/margin Update position margin
FuturesApi updatePositionLeverage POST /futures/{settle}/positions/{contract}/leverage Update position leverage
FuturesApi updatePositionRiskLimit POST /futures/{settle}/positions/{contract}/risk_limit Update position risk limit
FuturesApi setDualMode POST /futures/{settle}/dual_mode Enable or disable dual mode
FuturesApi getDualModePosition GET /futures/{settle}/dual_comp/positions/{contract} Retrieve position detail in dual mode
FuturesApi updateDualModePositionMargin POST /futures/{settle}/dual_comp/positions/{contract}/margin Update position margin in dual mode
FuturesApi updateDualModePositionLeverage POST /futures/{settle}/dual_comp/positions/{contract}/leverage Update position leverage in dual mode
FuturesApi updateDualModePositionRiskLimit POST /futures/{settle}/dual_comp/positions/{contract}/risk_limit Update position risk limit in dual mode
FuturesApi listFuturesOrders GET /futures/{settle}/orders List futures orders
FuturesApi createFuturesOrder POST /futures/{settle}/orders Create a futures order
FuturesApi cancelFuturesOrders DELETE /futures/{settle}/orders Cancel all `open` orders matched
FuturesApi createBatchFuturesOrder POST /futures/{settle}/batch_orders Create a batch of futures orders
FuturesApi getFuturesOrder GET /futures/{settle}/orders/{order_id} Get a single order
FuturesApi amendFuturesOrder PUT /futures/{settle}/orders/{order_id} Amend an order
FuturesApi cancelFuturesOrder DELETE /futures/{settle}/orders/{order_id} Cancel a single order
FuturesApi getMyTrades GET /futures/{settle}/my_trades List personal trading history
FuturesApi getMyTradesWithTimeRange GET /futures/{settle}/my_trades_timerange List personal trading history by time range
FuturesApi listPositionClose GET /futures/{settle}/position_close List position close history
FuturesApi listLiquidates GET /futures/{settle}/liquidates List liquidation history
FuturesApi listAutoDeleverages GET /futures/{settle}/auto_deleverages List Auto-Deleveraging History
FuturesApi countdownCancelAllFutures POST /futures/{settle}/countdown_cancel_all Countdown cancel orders
FuturesApi listPriceTriggeredOrders GET /futures/{settle}/price_orders List all auto orders
FuturesApi createPriceTriggeredOrder POST /futures/{settle}/price_orders Create a price-triggered order
FuturesApi cancelPriceTriggeredOrderList DELETE /futures/{settle}/price_orders Cancel all open orders
FuturesApi getPriceTriggeredOrder GET /futures/{settle}/price_orders/{order_id} Get a price-triggered order
FuturesApi cancelPriceTriggeredOrder DELETE /futures/{settle}/price_orders/{order_id} cancel a price-triggered order
MarginApi listMarginCurrencyPairs GET /margin/currency_pairs List all supported currency pairs supported in margin trading
MarginApi getMarginCurrencyPair GET /margin/currency_pairs/{currency_pair} Query one single margin currency pair
MarginApi listFundingBook GET /margin/funding_book Order book of lending loans
MarginApi listMarginAccounts GET /margin/accounts Margin account list
MarginApi listMarginAccountBook GET /margin/account_book List margin account balance change history
MarginApi listFundingAccounts GET /margin/funding_accounts Funding account list
MarginApi listLoans GET /margin/loans List all loans
MarginApi createLoan POST /margin/loans Lend or borrow
MarginApi mergeLoans POST /margin/merged_loans Merge multiple lending loans
MarginApi getLoan GET /margin/loans/{loan_id} Retrieve one single loan detail
MarginApi cancelLoan DELETE /margin/loans/{loan_id} Cancel lending loan
MarginApi updateLoan PATCH /margin/loans/{loan_id} Modify a loan
MarginApi listLoanRepayments GET /margin/loans/{loan_id}/repayment List loan repayment records
MarginApi repayLoan POST /margin/loans/{loan_id}/repayment Repay a loan
MarginApi listLoanRecords GET /margin/loan_records List repayment records of a specific loan
MarginApi getLoanRecord GET /margin/loan_records/{loan_record_id} Get one single loan record
MarginApi updateLoanRecord PATCH /margin/loan_records/{loan_record_id} Modify a loan record
MarginApi getAutoRepayStatus GET /margin/auto_repay Retrieve user auto repayment setting
MarginApi setAutoRepay POST /margin/auto_repay Update user's auto repayment setting
MarginApi getMarginTransferable GET /margin/transferable Get the max transferable amount for a specific margin currency
MarginApi getMarginBorrowable GET /margin/borrowable Get the max borrowable amount for a specific margin currency
MarginApi listCrossMarginCurrencies GET /margin/cross/currencies Currencies supported by cross margin.
MarginApi getCrossMarginCurrency GET /margin/cross/currencies/{currency} Retrieve detail of one single currency supported by cross margin
MarginApi getCrossMarginAccount GET /margin/cross/accounts Retrieve cross margin account
MarginApi listCrossMarginAccountBook GET /margin/cross/account_book Retrieve cross margin account change history
MarginApi listCrossMarginLoans GET /margin/cross/loans List cross margin borrow history
MarginApi createCrossMarginLoan POST /margin/cross/loans Create a cross margin borrow loan
MarginApi getCrossMarginLoan GET /margin/cross/loans/{loan_id} Retrieve single borrow loan detail
MarginApi listCrossMarginRepayments GET /margin/cross/repayments Retrieve cross margin repayments
MarginApi repayCrossMarginLoan POST /margin/cross/repayments Cross margin repayments
MarginApi getCrossMarginTransferable GET /margin/cross/transferable Get the max transferable amount for a specific cross margin currency
MarginApi getCrossMarginBorrowable GET /margin/cross/borrowable Get the max borrowable amount for a specific cross margin currency
OptionsApi listOptionsUnderlyings GET /options/underlyings List all underlyings
OptionsApi listOptionsExpirations GET /options/expirations List all expiration times
OptionsApi listOptionsContracts GET /options/contracts List all the contracts with specified underlying and expiration time
OptionsApi getOptionsContract GET /options/contracts/{contract} Query specified contract detail
OptionsApi listOptionsSettlements GET /options/settlements List settlement history
OptionsApi getOptionsSettlement GET /options/settlements/{contract} Get specified contract's settlement
OptionsApi listMyOptionsSettlements GET /options/my_settlements List my options settlements
OptionsApi listOptionsOrderBook GET /options/order_book Options order book
OptionsApi listOptionsTickers GET /options/tickers List tickers of options contracts
OptionsApi listOptionsUnderlyingTickers GET /options/underlying/tickers/{underlying} Get underlying ticker
OptionsApi listOptionsCandlesticks GET /options/candlesticks Get options candlesticks
OptionsApi listOptionsUnderlyingCandlesticks GET /options/underlying/candlesticks Mark price candlesticks of an underlying
OptionsApi listOptionsTrades GET /options/trades Options trade history
OptionsApi listOptionsAccount GET /options/accounts List options account
OptionsApi listOptionsAccountBook GET /options/account_book List account changing history
OptionsApi listOptionsPositions GET /options/positions List user's positions of specified underlying
OptionsApi getOptionsPosition GET /options/positions/{contract} Get specified contract position
OptionsApi listOptionsPositionClose GET /options/position_close List user's liquidation history of specified underlying
OptionsApi listOptionsOrders GET /options/orders List options orders
OptionsApi createOptionsOrder POST /options/orders Create an options order
OptionsApi cancelOptionsOrders DELETE /options/orders Cancel all `open` orders matched
OptionsApi getOptionsOrder GET /options/orders/{order_id} Get a single order
OptionsApi cancelOptionsOrder DELETE /options/orders/{order_id} Cancel a single order
OptionsApi listMyOptionsTrades GET /options/my_trades List personal trading history
RebateApi agencyTransactionHistory GET /rebate/agency/transaction_history The broker obtains the transaction history of the recommended user
RebateApi agencyCommissionsHistory GET /rebate/agency/commission_history The broker obtains the commission history of the recommended user
SpotApi listCurrencies GET /spot/currencies List all currencies' details
SpotApi getCurrency GET /spot/currencies/{currency} Get details of a specific currency
SpotApi listCurrencyPairs GET /spot/currency_pairs List all currency pairs supported
SpotApi getCurrencyPair GET /spot/currency_pairs/{currency_pair} Get details of a specifc currency pair
SpotApi listTickers GET /spot/tickers Retrieve ticker information
SpotApi listOrderBook GET /spot/order_book Retrieve order book
SpotApi listTrades GET /spot/trades Retrieve market trades
SpotApi listCandlesticks GET /spot/candlesticks Market candlesticks
SpotApi getFee GET /spot/fee Query user trading fee rates
SpotApi getBatchSpotFee GET /spot/batch_fee Query a batch of user trading fee rates
SpotApi listSpotAccounts GET /spot/accounts List spot accounts
SpotApi createBatchOrders POST /spot/batch_orders Create a batch of orders
SpotApi listAllOpenOrders GET /spot/open_orders List all open orders
SpotApi createCrossLiquidateOrder POST /spot/cross_liquidate_orders close position when cross-currency is disabled
SpotApi listOrders GET /spot/orders List orders
SpotApi createOrder POST /spot/orders Create an order
SpotApi cancelOrders DELETE /spot/orders Cancel all `open` orders in specified currency pair
SpotApi cancelBatchOrders POST /spot/cancel_batch_orders Cancel a batch of orders with an ID list
SpotApi getOrder GET /spot/orders/{order_id} Get a single order
SpotApi cancelOrder DELETE /spot/orders/{order_id} Cancel a single order
SpotApi amendOrder PATCH /spot/orders/{order_id} Amend an order
SpotApi listMyTrades GET /spot/my_trades List personal trading history
SpotApi getSystemTime GET /spot/time Get server current time
SpotApi countdownCancelAllSpot POST /spot/countdown_cancel_all Countdown cancel orders
SpotApi listSpotPriceTriggeredOrders GET /spot/price_orders Retrieve running auto order list
SpotApi createSpotPriceTriggeredOrder POST /spot/price_orders Create a price-triggered order
SpotApi cancelSpotPriceTriggeredOrderList DELETE /spot/price_orders Cancel all open orders
SpotApi getSpotPriceTriggeredOrder GET /spot/price_orders/{order_id} Get a price-triggered order
SpotApi cancelSpotPriceTriggeredOrder DELETE /spot/price_orders/{order_id} cancel a price-triggered order
SubAccountApi listSubAccounts GET /sub_accounts List sub-accounts
SubAccountApi createSubAccounts POST /sub_accounts Create a new sub-account
SubAccountApi getSubAccount GET /sub_accounts/{user_id} Get the sub-account
SubAccountApi listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API Key of the sub-account
SubAccountApi createSubAccountKeys POST /sub_accounts/{user_id}/keys Create API Key of the sub-account
SubAccountApi getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get the API Key of the sub-account
SubAccountApi updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update API key of the sub-account
SubAccountApi deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete API key of the sub-account
SubAccountApi lockSubAccount POST /sub_accounts/{user_id}/lock Lock the sub-account
SubAccountApi unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock the sub-account
WalletApi listCurrencyChains GET /wallet/currency_chains List chains supported for specified currency
WalletApi getDepositAddress GET /wallet/deposit_address Generate currency deposit address
WalletApi listWithdrawals GET /wallet/withdrawals Retrieve withdrawal records
WalletApi listDeposits GET /wallet/deposits Retrieve deposit records
WalletApi transfer POST /wallet/transfers Transfer between trading accounts
WalletApi listSubAccountTransfers GET /wallet/sub_account_transfers Retrieve transfer records between main and sub accounts
WalletApi transferWithSubAccount POST /wallet/sub_account_transfers Transfer between main and sub accounts
WalletApi subAccountToSubAccount POST /wallet/sub_account_to_sub_account Sub-account transfers to sub-account
WalletApi listWithdrawStatus GET /wallet/withdraw_status Retrieve withdrawal status
WalletApi listSubAccountBalances GET /wallet/sub_account_balances Retrieve sub account balances
WalletApi listSubAccountMarginBalances GET /wallet/sub_account_margin_balances Query sub accounts' margin balances
WalletApi listSubAccountFuturesBalances GET /wallet/sub_account_futures_balances Query sub accounts' futures account balances
WalletApi listSubAccountCrossMarginBalances GET /wallet/sub_account_cross_margin_balances Query subaccount's cross_margin account info
WalletApi listSavedAddress GET /wallet/saved_address Query saved address
WalletApi getTradeFee GET /wallet/fee Retrieve personal trading fee
WalletApi getTotalBalance GET /wallet/total_balance Retrieve user's total balances
WithdrawalApi withdraw POST /withdrawals Withdraw
WithdrawalApi cancelWithdrawal DELETE /withdrawals/{withdrawal_id} Cancel withdrawal with specified ID

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiv4

  • Type: Gate APIv4

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

Author

support@mail.gate.io

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • PHP 99.9%
  • Shell 0.1%