MiningApi: Mining operations

MiningApiR Documentation

Mining operations

Description

binanceRapi.Mining

Format

An R6Class generator object

Methods

SapiV1MiningHashTransferConfigCancelPost Cancel Hashrate Resale configuration (USER_DATA) Weight(IP): 5

  • @param config.id character

  • @param user.name character

  • @param recv.window integer

  • @returnType InlineResponse200110

  • status code : 200 | Success flag

  • return type : InlineResponse200110

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningHashTransferConfigDetailsListGet Hashrate Resale List (USER_DATA) Weight(IP): 5

  • @param page.index integer

  • @param page.size character

  • @param recv.window integer

  • @returnType InlineResponse200107

  • status code : 200 | List of hashrate resales

  • return type : InlineResponse200107

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningHashTransferConfigPost Hashrate Resale Request (USER_DATA) Weight(IP): 5

  • @param user.name character

  • @param algo character

  • @param to.pool.user character

  • @param hash.rate character

  • @param start.date character

  • @param end.date character

  • @param recv.window integer

  • @returnType InlineResponse200109

  • status code : 200 | Mining Account Id

  • return type : InlineResponse200109

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningHashTransferProfitDetailsGet Hashrate Resale Details (USER_DATA) Weight(IP): 5

  • @param config.id character

  • @param user.name character

  • @param page.index integer

  • @param page.size character

  • @param recv.window integer

  • @returnType InlineResponse200108

  • status code : 200 | List of hashrate resale details

  • return type : InlineResponse200108

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningPaymentListGet Earnings List (USER_DATA) Weight(IP): 5

  • @param algo character

  • @param user.name character

  • @param coin character

  • @param start.date character

  • @param end.date character

  • @param page.index integer

  • @param page.size character

  • @param recv.window integer

  • @returnType InlineResponse200105

  • status code : 200 | List of earnings

  • return type : InlineResponse200105

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningPaymentOtherGet Extra Bonus List (USER_DATA) Weight(IP): 5

  • @param algo character

  • @param user.name character

  • @param coin character

  • @param start.date character

  • @param end.date character

  • @param page.index integer

  • @param page.size character

  • @param recv.window integer

  • @returnType InlineResponse200106

  • status code : 200 | List of extra bonuses

  • return type : InlineResponse200106

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningPaymentUidGet Mining Account Earning (USER_DATA) Weight(IP): 5

  • @param algo character

  • @param timestamp integer

  • @param signature character

  • @param start.date character

  • @param end.date character

  • @param page.index integer

  • @param page.size character

  • @param recv.window integer

  • @returnType InlineResponse200113

  • status code : 200 | Mining account earnings

  • return type : InlineResponse200113

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningPubAlgoListGet Acquiring Algorithm (MARKET_DATA) Weight(IP): 1

  • @param recv.window integer

  • @returnType InlineResponse200101

  • status code : 200 | Algorithm information

  • return type : InlineResponse200101

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

SapiV1MiningPubCoinListGet Acquiring CoinName (MARKET_DATA) Weight(IP): 1

  • @param recv.window integer

  • @returnType InlineResponse200102

  • status code : 200 | Coin information

  • return type : InlineResponse200102

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

SapiV1MiningStatisticsUserListGet Account List (USER_DATA) Weight(IP): 5

  • @param algo character

  • @param user.name character

  • @param recv.window integer

  • @returnType InlineResponse200112

  • status code : 200 | List of mining accounts

  • return type : InlineResponse200112

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningStatisticsUserStatusGet Statistic List (USER_DATA) Weight(IP): 5

  • @param algo character

  • @param user.name character

  • @param recv.window integer

  • @returnType InlineResponse200111

  • status code : 200 | Mining account statistics

  • return type : InlineResponse200111

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningWorkerDetailGet Request for Detail Miner List (USER_DATA) Weight(IP): 5

  • @param algo character

  • @param user.name character

  • @param worker.name character

  • @param recv.window integer

  • @returnType InlineResponse200103

  • status code : 200 | List of workers' hashrates'

  • return type : InlineResponse200103

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1MiningWorkerListGet Request for Miner List (USER_DATA) Weight(IP): 5

  • @param algo character

  • @param user.name character

  • @param page.index integer

  • @param sort integer

  • @param sort.column integer

  • @param worker.status integer

  • @param recv.window integer

  • @returnType InlineResponse200104

  • status code : 200 | List of workers

  • return type : InlineResponse200104

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods


Method new()

Usage
MiningApi$new(apiClient)

Method SapiV1MiningHashTransferConfigCancelPost()

Usage
MiningApi$SapiV1MiningHashTransferConfigCancelPost(
  config.id,
  user.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningHashTransferConfigCancelPostWithHttpInfo()

Usage
MiningApi$SapiV1MiningHashTransferConfigCancelPostWithHttpInfo(
  config.id,
  user.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningHashTransferConfigDetailsListGet()

Usage
MiningApi$SapiV1MiningHashTransferConfigDetailsListGet(
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningHashTransferConfigDetailsListGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningHashTransferConfigDetailsListGetWithHttpInfo(
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningHashTransferConfigPost()

Usage
MiningApi$SapiV1MiningHashTransferConfigPost(
  user.name,
  algo,
  to.pool.user,
  hash.rate,
  timestamp,
  signature,
  start.date = NULL,
  end.date = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningHashTransferConfigPostWithHttpInfo()

Usage
MiningApi$SapiV1MiningHashTransferConfigPostWithHttpInfo(
  user.name,
  algo,
  to.pool.user,
  hash.rate,
  start.date = NULL,
  end.date = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningHashTransferProfitDetailsGet()

Usage
MiningApi$SapiV1MiningHashTransferProfitDetailsGet(
  config.id,
  user.name,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningHashTransferProfitDetailsGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningHashTransferProfitDetailsGetWithHttpInfo(
  config.id,
  user.name,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningPaymentListGet()

Usage
MiningApi$SapiV1MiningPaymentListGet(
  algo,
  user.name,
  coin = NULL,
  start.date = NULL,
  end.date = NULL,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningPaymentListGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningPaymentListGetWithHttpInfo(
  algo,
  user.name,
  coin = NULL,
  start.date = NULL,
  end.date = NULL,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningPaymentOtherGet()

Usage
MiningApi$SapiV1MiningPaymentOtherGet(
  algo,
  user.name,
  coin = NULL,
  start.date = NULL,
  end.date = NULL,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningPaymentOtherGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningPaymentOtherGetWithHttpInfo(
  algo,
  user.name,
  coin = NULL,
  start.date = NULL,
  end.date = NULL,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningPaymentUidGet()

Usage
MiningApi$SapiV1MiningPaymentUidGet(
  algo,
  start.date = NULL,
  end.date = NULL,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningPaymentUidGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningPaymentUidGetWithHttpInfo(
  algo,
  start.date = NULL,
  end.date = NULL,
  page.index = NULL,
  page.size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningPubAlgoListGet()

Usage
MiningApi$SapiV1MiningPubAlgoListGet(recv.window = NULL, ...)

Method SapiV1MiningPubAlgoListGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningPubAlgoListGetWithHttpInfo(recv.window = NULL, ...)

Method SapiV1MiningPubCoinListGet()

Usage
MiningApi$SapiV1MiningPubCoinListGet(recv.window = NULL, ...)

Method SapiV1MiningPubCoinListGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningPubCoinListGetWithHttpInfo(recv.window = NULL, ...)

Method SapiV1MiningStatisticsUserListGet()

Usage
MiningApi$SapiV1MiningStatisticsUserListGet(
  algo,
  user.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningStatisticsUserListGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningStatisticsUserListGetWithHttpInfo(
  algo,
  user.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningStatisticsUserStatusGet()

Usage
MiningApi$SapiV1MiningStatisticsUserStatusGet(
  algo,
  user.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningStatisticsUserStatusGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningStatisticsUserStatusGetWithHttpInfo(
  algo,
  user.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningWorkerDetailGet()

Usage
MiningApi$SapiV1MiningWorkerDetailGet(
  algo,
  user.name,
  worker.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningWorkerDetailGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningWorkerDetailGetWithHttpInfo(
  algo,
  user.name,
  worker.name,
  recv.window = NULL,
  ...
)

Method SapiV1MiningWorkerListGet()

Usage
MiningApi$SapiV1MiningWorkerListGet(
  algo,
  user.name,
  page.index = NULL,
  sort = NULL,
  sort.column = NULL,
  worker.status = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1MiningWorkerListGetWithHttpInfo()

Usage
MiningApi$SapiV1MiningWorkerListGetWithHttpInfo(
  algo,
  user.name,
  page.index = NULL,
  sort = NULL,
  sort.column = NULL,
  worker.status = NULL,
  recv.window = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage
MiningApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
####################  SapiV1MiningHashTransferConfigCancelPost  ####################

library(binanceRapi)
var.config.id <- 'config.id_example' # character | Mining ID
var.user.name <- 'user.name_example' # character | Mining Account
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Cancel Hashrate Resale configuration (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningHashTransferConfigCancelPost(var.config.id, var.user.name, recv.window=var.recv.window)


####################  SapiV1MiningHashTransferConfigDetailsListGet  ####################

library(binanceRapi)
var.page.index <- 56 # integer | Page number, default is first page, start form 1
var.page.size <- 'page.size_example' # character | Number of pages, minimum 10, maximum 200
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Hashrate Resale List (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningHashTransferConfigDetailsListGet(page.index=var.page.index, page.size=var.page.size, recv.window=var.recv.window)


####################  SapiV1MiningHashTransferConfigPost  ####################

library(binanceRapi)
var.user.name <- 'user.name_example' # character | Mining Account
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.to.pool.user <- 'to.pool.user_example' # character | Mining Account
var.hash.rate <- 'hash.rate_example' # character | Resale hashrate h/s must be transferred (BTC is greater than 500000000000 ETH is greater than 500000)
var.start.date <- 'start.date_example' # character | Search date, millisecond timestamp, while empty query all
var.end.date <- 'end.date_example' # character | Search date, millisecond timestamp, while empty query all
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Hashrate Resale Request (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningHashTransferConfigPost(var.user.name, var.algo, var.to.pool.user, var.hash.rate, start.date=var.start.date, end.date=var.end.date, recv.window=var.recv.window)


####################  SapiV1MiningHashTransferProfitDetailsGet  ####################

library(binanceRapi)
var.config.id <- 'config.id_example' # character | Mining ID
var.user.name <- 'user.name_example' # character | Mining Account
var.page.index <- 56 # integer | Page number, default is first page, start form 1
var.page.size <- 'page.size_example' # character | Number of pages, minimum 10, maximum 200
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Hashrate Resale Details (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningHashTransferProfitDetailsGet(var.config.id, var.user.name, page.index=var.page.index, page.size=var.page.size, recv.window=var.recv.window)


####################  SapiV1MiningPaymentListGet  ####################

library(binanceRapi)
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.user.name <- 'user.name_example' # character | Mining Account
var.coin <- 'BNB' # character | Coin name
var.start.date <- 'start.date_example' # character | Search date, millisecond timestamp, while empty query all
var.end.date <- 'end.date_example' # character | Search date, millisecond timestamp, while empty query all
var.page.index <- 56 # integer | Page number, default is first page, start form 1
var.page.size <- 'page.size_example' # character | Number of pages, minimum 10, maximum 200
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Earnings List (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningPaymentListGet(var.algo, var.user.name, coin=var.coin, start.date=var.start.date, end.date=var.end.date, page.index=var.page.index, page.size=var.page.size, recv.window=var.recv.window)


####################  SapiV1MiningPaymentOtherGet  ####################

library(binanceRapi)
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.user.name <- 'user.name_example' # character | Mining Account
var.coin <- 'BNB' # character | Coin name
var.start.date <- 'start.date_example' # character | Search date, millisecond timestamp, while empty query all
var.end.date <- 'end.date_example' # character | Search date, millisecond timestamp, while empty query all
var.page.index <- 56 # integer | Page number, default is first page, start form 1
var.page.size <- 'page.size_example' # character | Number of pages, minimum 10, maximum 200
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Extra Bonus List (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningPaymentOtherGet(var.algo, var.user.name, coin=var.coin, start.date=var.start.date, end.date=var.end.date, page.index=var.page.index, page.size=var.page.size, recv.window=var.recv.window)


####################  SapiV1MiningPaymentUidGet  ####################

library(binanceRapi)
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.start.date <- 'start.date_example' # character | Search date, millisecond timestamp, while empty query all
var.end.date <- 'end.date_example' # character | Search date, millisecond timestamp, while empty query all
var.page.index <- 56 # integer | Page number, default is first page, start form 1
var.page.size <- 'page.size_example' # character | Number of pages, minimum 10, maximum 200
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Mining Account Earning (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningPaymentUidGet(var.algo, start.date=var.start.date, end.date=var.end.date, page.index=var.page.index, page.size=var.page.size, recv.window=var.recv.window)


####################  SapiV1MiningPubAlgoListGet  ####################

library(binanceRapi)
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Acquiring Algorithm (MARKET_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningPubAlgoListGet(recv.window=var.recv.window)


####################  SapiV1MiningPubCoinListGet  ####################

library(binanceRapi)
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Acquiring CoinName (MARKET_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningPubCoinListGet(recv.window=var.recv.window)


####################  SapiV1MiningStatisticsUserListGet  ####################

library(binanceRapi)
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.user.name <- 'user.name_example' # character | Mining Account
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Account List (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningStatisticsUserListGet(var.algo, var.user.name, recv.window=var.recv.window)


####################  SapiV1MiningStatisticsUserStatusGet  ####################

library(binanceRapi)
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.user.name <- 'user.name_example' # character | Mining Account
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Statistic List (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningStatisticsUserStatusGet(var.algo, var.user.name, recv.window=var.recv.window)


####################  SapiV1MiningWorkerDetailGet  ####################

library(binanceRapi)
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.user.name <- 'user.name_example' # character | Mining Account
var.worker.name <- 'worker.name_example' # character | Miner’s name
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Request for Detail Miner List (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningWorkerDetailGet(var.algo, var.user.name, var.worker.name, recv.window=var.recv.window)


####################  SapiV1MiningWorkerListGet  ####################

library(binanceRapi)
var.algo <- 'algo_example' # character | Algorithm(sha256)
var.user.name <- 'user.name_example' # character | Mining Account
var.page.index <- 56 # integer | Page number, default is first page, start form 1
var.sort <- 56 # integer | sort sequence(default=0)0 positive sequence, 1 negative sequence
var.sort.column <- 56 # integer | Sort by( default 1): 1: miner name, 2: real-time computing power, 3: daily average computing power, 4: real-time rejection rate, 5: last submission time
var.worker.status <- 56 # integer | miners status(default=0)0 all, 1 valid, 2 invalid, 3 failure
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Request for Miner List (USER_DATA)
api.instance <- MiningApi$new()

result <- api.instance$SapiV1MiningWorkerListGet(var.algo, var.user.name, page.index=var.page.index, sort=var.sort, sort.column=var.sort.column, worker.status=var.worker.status, recv.window=var.recv.window)



## End(Not run)

grahamjwhite/binanceRapi documentation built on Nov. 22, 2022, 9:37 p.m.