Skip to content
This repository was archived by the owner on Jun 7, 2025. It is now read-only.

Latest commit

 

History

History
306 lines (214 loc) · 7.41 KB

API.md

File metadata and controls

306 lines (214 loc) · 7.41 KB
accountStats(uuid) ⇒ Promise

Get an account stats.

calculate(body) ⇒ Promise

Get calculated reward for a coin.

coins(coin) ⇒ Promise

Get coins list | a coin info.

news() ⇒ Promise

Get the pool news.

pay(uuid) ⇒ Promise

Ask a payment for a coin.

payouts(uuid, params) ⇒ Promise

Get a coin payouts.

pool() ⇒ Promise

Get the pool info.

referral(uuid) ⇒ Promise

Get your referral code.

settings(body) ⇒ Promise

Set settings for a coin (1 at a time).

stats() ⇒ Promise

Get the pool stats.

version(params) ⇒ Promise

Get the website | miner version.

wallet(params) ⇒ Promise

Get a wallet | account info.

workers(uuid) ⇒ Promise

Get your workers stats.

accountStats(uuid) ⇒ Promise

Get an account stats.

Kind: method
Returns: Promise

Param Type Description
uuid String uuid: can be found in client.wallet()

Example

accountStats("0cc5691e-cedb-11eb-b8bc-0242ac130003");

calculate(algo, coin, hashrate) ⇒ Promise

Get calculated reward for a coin.

Kind: method
Returns: Promise

Param Type Description
algo String algorithm
coin String coin symbol
hashrate Number hashrate for this algorithm

Example

calculate("ethash", "DOGE", 30);

coin(coin, more) ⇒ Promise

Get a coin info.

Kind: method
Returns: Promise

Param Type Description
coin String coin symbol
more Boolean show more infos: payment info + rewards

Example

coin("ETH");
coin("ETH", true);

coins() ⇒ Promise

Get all pool coins.

Kind: method
Returns: Promise
Example

coins();

news() ⇒ Promise

Get the pool news.

Kind: method
Returns: Promise
Example

news();

pay(uuid) ⇒ Promise

Ask a payment for a coin.

Kind: method
Returns: Promise

Param Type Description
uuid String uuid: can be found in client.wallet()

Example

pay("0cc5691e-cedb-11eb-b8bc-0242ac130003");

payouts(uuid, page) ⇒ Promise

Get a coin payouts.

Kind: method
Returns: Promise

Param Type Description
uuid String uuid: can be found in client.wallet()
page Number payouts page

Example

payouts("0cc5691e-cedb-11eb-b8bc-0242ac130003");
payouts("0cc5691e-cedb-11eb-b8bc-0242ac130003", 1);

pool() ⇒ Promise

Get the pool info.

Kind: method
Returns: Promise
Example

pool();

referral(uuid) ⇒ Promise

Get your referral code.

Kind: method
Returns: Promise

Param Type Description
uuid String uuid: can be found in client.wallet()

Example

referral("0cc5691e-cedb-11eb-b8bc-0242ac130003");

settings(body) ⇒ Promise

Set settings for a coin (1 at a time).

Kind: method
Returns: Promise

Param Type Description
body Object request body
body.uuid String uuid: can be found in client.wallet()
body.autoPay Boolean auto pay setting
body.network String network setting

Example

settings({ uuid: "0cc5691e-cedb-11eb-b8bc-0242ac130003", autoPay: true });
settings({ uuid: "0cc5691e-cedb-11eb-b8bc-0242ac130003", network: "BSC" });

stats() ⇒ Promise

Get the pool stats.

Kind: method
Returns: Promise

Example

stats();

version(params) ⇒ Promise

Get the website | miner version.

Kind: method
Returns: Promise

Param Type Description
params Object query params
params.type String type: website / miner

Example

version({ type: "website" });
version({ type: "miner" });

wallet(params) ⇒ Promise

Get a wallet | account stats.

Kind: method
Returns: Promise

Param Type Description
params Object query params
params.address String wallet address
params.uuid String uuid
params.coin String coin symbol

Example

wallet({ address: "0xfd2D76F7Cf04863F2B221E56Af6fF94105EC2e5e", coin: "ETH" });
wallet({ uuid: "0cc5691e-cedb-11eb-b8bc-0242ac130003" });

workers(uuid) ⇒ Promise

Get your workers stats.

Kind: method
Returns: Promise

Param Type Description
uuid String uuid: can be found in client.wallet()

Example

workers("0cc5691e-cedb-11eb-b8bc-0242ac130003");