Download the PHP package weoka/stakecube-php-sdk without Composer

StakeCube-PHP-SDK

Unofficial StakeCube API SDK for PHP - Available on Composer!

Install

Composer: composer require weoka/stakecube-php-sdk

...or clone via git and import the module yourself!

Setup

To start using the StakeCube SDK, you'll need to import the Stakecube class and initialize an instance with your public and private key as parameters. If you only intend to use public endpoints, you can just send random string as parameters.

If you don't have your pair keys, grab them from your Profile

Usage

Note: If you're looking for Advanced REST API documentation, please use this document from DevCube!

Get Arbitrage Info

Gets arbitrage information for a chosen coin ticker.

• Method: getArbitrageInfo($ticker);

Example:

Get Markets

Gets a list of all StakeCube markets under the chosen base market, optionally sorted by volume or change, but by default sorted alphabetically.

• Method: getMarkets($base, $orderBy);

Example:

Get OHLC Data

Gets an array of the last 500 candles for the chosen market pair and interval.

• Method: getOhlcData($market, $interval);

Example:

Get MineCube Info

Gets the current real-time info for MineCube, such as total and available workers, the price of workers, and the payouts-in-progress status.

• Method: getMineCubeInfo();

Example:

Get MineCube Miners

Gets a list of all Miners belonging to MineCube, you may optionally specify a coin to see miners for only that coin, such as 'ETH' which uses AMD GPUs, or 'DASH' which uses StrongU ASICs.

• Method: getMineCubeMiners($coin);

Example:

Get Rate Limits

Gets the current global StakeCube rate-limits for APIs.

• Method: getRatelimits();

Example:

Get Trades

Returns the last trades of a specified market pair, optionally with a custom results limit.

• Method: getTrades($market);

Example:

Get Orderbook

Gets the orderbook of a chosen market, optionally a specified side, but by default will load both orderbook sides.

• Method: getOrderbook($market);

Example:

Private APIs

These APIs require you to be using real API keys with sufficient permissions to perform the private action. For example, withdrawals will work on any key with the Withdrawals Permission enabled, order placing/cancelling will work on a key with "Full Permissions", but will not work on a "Read only" key, be aware of this and customize your keys accordingly for security!

Get Account (Auth Required)

Returns general information about your StakeCube account, including wallets, balances, fee-rate in percentage and your account username.

• Method: getAccount();

Example:

Withdraw (Auth Required)

Creates a withdrawal request with a specified coin, address and amount.

• Method: withdraw($ticker, $address, $amount);

Example:

Get Open Orders (Auth Required)

Returns a list of all open orders for all StakeCube Exchange markets.

• Method: getOpenOrders();

Example:

Get My Trades (Auth Required)

Returns a list of all trades, you can leave the market empty ("") to return all trades, or specify a market such as "DOGEC_BTC" to return those market orders, you may also specify a limit of the amount of returned trades, of which the default is 100 trades.

• Method: getMyTrades($market, $limit);

Example:

Get Order History (Auth Required)

Returns a list of all orders from a specified market such as "DOGEC_BTC", you may also specify a limit of the amount of returned orders, of which the default is 100 orders.

• Method: getOrderHistory($market, $limit);

Example:

Post Order (Auth Required)

Creates an exchange order for the specified market pair, orderbook side, price and amount.

• Method: postOrder($market, $side, $price, $amount);

Example:

Cancel Order (Auth Required)

Cancels an open order by it's orderId

• Method: cancel($orderId);

Example:

Cancel All (Auth Required)

Cancels all orders in a specified market pair.

• Method: cancelAll($market);

Example:

Set MineCube Payout Coin (Auth Required)

Sets a coin as the preferred payout coin to receive upon future MineCube payouts.

• Method: setMineCubePayoutCoin($coin);

Example:

Buy MineCube Workers (Auth Required)

Buys a specified amount of MineCube workers using the chosen payment method.

• Method: buyMineCubeWorkers($method, $workers);

Example: