SavingsApi: Savings operations

SavingsApiR Documentation

Savings operations

Description

binanceRapi.Savings

Format

An R6Class generator object

Methods

SapiV1LendingCustomizedFixedPurchasePost Purchase Fixed/Activity Project (USER_DATA) Weight(IP): 1

  • @param project.id character

  • @param lot character

  • @param recv.window integer

  • @returnType InlineResponse20090

  • status code : 200 | Generated Purchase Id

  • return type : InlineResponse20090

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingDailyProductListGet Get Flexible Product List (USER_DATA) Weight(IP): 1

  • @param status Enum < [ALL, SUBSCRIBABLE, UNSUBSCRIBABLE] >

  • @param featured Enum < [ALL, TRUE] >

  • @param current integer

  • @param size integer

  • @param recv.window integer

  • @returnType list( inline_response_200_84 )

  • status code : 200 | List of flexible products

  • return type : array[InlineResponse20084]

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingDailyPurchasePost Purchase Flexible Product (USER_DATA) Weight(IP): 1

  • @param product.id character

  • @param amount numeric

  • @param recv.window integer

  • @returnType InlineResponse20086

  • status code : 200 | Generated Purchase Id

  • return type : InlineResponse20086

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingDailyRedeemPost Redeem Flexible Product (USER_DATA) Weight(IP): 1

  • @param product.id character

  • @param amount numeric

  • @param type Enum < [FAST, NORMAL] >

  • @param recv.window integer

  • status code : 200 | OK

  • return type : object

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingDailyTokenPositionGet Get Flexible Product Position (USER_DATA) Weight(IP): 1

  • @param asset character

  • @param recv.window integer

  • @returnType list( inline_response_200_88 )

  • status code : 200 | List of flexible product positions

  • return type : array[InlineResponse20088]

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingDailyUserLeftQuotaGet Get Left Daily Purchase Quota of Flexible Product (USER_DATA) Weight(IP): 1

  • @param product.id character

  • @param recv.window integer

  • @returnType InlineResponse20085

  • status code : 200 | Daily purchase quote of flexible product left

  • return type : InlineResponse20085

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingDailyUserRedemptionQuotaGet Get Left Daily Redemption Quota of Flexible Product (USER_DATA) Weight(IP): 1

  • @param product.id character

  • @param type Enum < [FAST, NORMAL] >

  • @param recv.window integer

  • @returnType InlineResponse20087

  • status code : 200 | Daily redemption quota of flexible product left

  • return type : InlineResponse20087

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingPositionChangedPost Change Fixed/Activity Position to Daily Position (USER_DATA) - PositionId is mandatory parameter for fixed position. Weight(IP): 1

  • @param project.id character

  • @param lot character

  • @param position.id character

  • @param recv.window integer

  • @returnType InlineResponse20094

  • status code : 200 | Purchase information

  • return type : InlineResponse20094

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingProjectListGet Get Fixed/Activity Project List(USER_DATA) Weight(IP): 1

  • @param type Enum < [ACTIVITY, CUSTOMIZED_FIXED] >

  • @param asset character

  • @param status Enum < [ALL, SUBSCRIBABLE, UNSUBSCRIBABLE] >

  • @param is.sort.asc character

  • @param sort.by Enum < [START_TIME, LOT_SIZE, INTEREST_RATE, DURATION] >

  • @param current integer

  • @param size integer

  • @param recv.window integer

  • @returnType list( inline_response_200_89 )

  • status code : 200 | List of fixed projects

  • return type : array[InlineResponse20089]

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingProjectPositionListGet Get Fixed/Activity Project Position (USER_DATA) Weight(IP): 1

  • @param asset character

  • @param project.id character

  • @param status Enum < [ALL, SUBSCRIBABLE, UNSUBSCRIBABLE] >

  • @param recv.window integer

  • @returnType list( inline_response_200_91 )

  • status code : 200 | List of fixed project positions

  • return type : array[InlineResponse20091]

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingUnionAccountGet Lending Account (USER_DATA) Weight(IP): 1

  • @param recv.window integer

  • @returnType InlineResponse20092

  • status code : 200 | Lending account

  • return type : InlineResponse20092

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingUnionInterestHistoryGet Get Interest History (USER_DATA) - The time between startTime and endTime cannot be longer than 30 days. - If startTime and endTime are both not sent, then the last 30 days&#39; data will be returned. Weight(IP): 1

  • @param lending.type Enum < [DAILY, ACTIVITY, CUSTOMIZED_FIXED] >

  • @param asset character

  • @param start.time integer

  • @param end.time integer

  • @param current integer

  • @param size integer

  • @param recv.window integer

  • @returnType list( inline_response_200_93 )

  • status code : 200 | History of interest

  • return type : array[InlineResponse20093]

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingUnionPurchaseRecordGet Get Purchase Record (USER_DATA) - The time between startTime and endTime cannot be longer than 30 days. - If startTime and endTime are both not sent, then the last 30 days&#39; data will be returned. Weigh(IP): 1

  • @param lending.type Enum < [DAILY, ACTIVITY, CUSTOMIZED_FIXED] >

  • @param asset character

  • @param start.time integer

  • @param end.time integer

  • @param current integer

  • @param size integer

  • @param recv.window integer

  • @returnType OneOfsavingsFlexiblePurchaseRecordsavingsFixedActivityPurchaseRecord

  • status code : 200 | List of flexible or Fixed/Activity products

  • return type : OneOfsavingsFlexiblePurchaseRecordsavingsFixedActivityPurchaseRecord

  • response headers :

  • status code : 400 | Bad Request

  • return type : Error

  • response headers :

  • status code : 401 | Unauthorized Request

  • return type : Error

  • response headers :

SapiV1LendingUnionRedemptionRecordGet Get Redemption Record (USER_DATA) - The time between startTime and endTime cannot be longer than 30 days. - If startTime and endTime are both not sent, then the last 30 days&#39; data will be returned. Weight(IP): 1

  • @param lending.type Enum < [DAILY, ACTIVITY, CUSTOMIZED_FIXED] >

  • @param asset character

  • @param start.time integer

  • @param end.time integer

  • @param current integer

  • @param size integer

  • @param recv.window integer

  • @returnType OneOfsavingsFlexibleRedemptionRecordsavingsFixedActivityRedemptionRecord

  • status code : 200 | History of Flexible or Fixed/Activity Redemptions

  • return type : OneOfsavingsFlexibleRedemptionRecordsavingsFixedActivityRedemptionRecord

  • 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
SavingsApi$new(apiClient)

Method SapiV1LendingCustomizedFixedPurchasePost()

Usage
SavingsApi$SapiV1LendingCustomizedFixedPurchasePost(
  project.id,
  lot,
  recv.window = NULL,
  ...
)

Method SapiV1LendingCustomizedFixedPurchasePostWithHttpInfo()

Usage
SavingsApi$SapiV1LendingCustomizedFixedPurchasePostWithHttpInfo(
  project.id,
  lot,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyProductListGet()

Usage
SavingsApi$SapiV1LendingDailyProductListGet(
  status = NULL,
  featured = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyProductListGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingDailyProductListGetWithHttpInfo(
  status = NULL,
  featured = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyPurchasePost()

Usage
SavingsApi$SapiV1LendingDailyPurchasePost(
  product.id,
  amount,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyPurchasePostWithHttpInfo()

Usage
SavingsApi$SapiV1LendingDailyPurchasePostWithHttpInfo(
  product.id,
  amount,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyRedeemPost()

Usage
SavingsApi$SapiV1LendingDailyRedeemPost(
  product.id,
  amount,
  type,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyRedeemPostWithHttpInfo()

Usage
SavingsApi$SapiV1LendingDailyRedeemPostWithHttpInfo(
  product.id,
  amount,
  type,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyTokenPositionGet()

Usage
SavingsApi$SapiV1LendingDailyTokenPositionGet(asset, recv.window = NULL, ...)

Method SapiV1LendingDailyTokenPositionGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingDailyTokenPositionGetWithHttpInfo(
  asset,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyUserLeftQuotaGet()

Usage
SavingsApi$SapiV1LendingDailyUserLeftQuotaGet(
  product.id,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyUserLeftQuotaGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingDailyUserLeftQuotaGetWithHttpInfo(
  product.id,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyUserRedemptionQuotaGet()

Usage
SavingsApi$SapiV1LendingDailyUserRedemptionQuotaGet(
  product.id,
  type,
  recv.window = NULL,
  ...
)

Method SapiV1LendingDailyUserRedemptionQuotaGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingDailyUserRedemptionQuotaGetWithHttpInfo(
  product.id,
  type,
  recv.window = NULL,
  ...
)

Method SapiV1LendingPositionChangedPost()

Usage
SavingsApi$SapiV1LendingPositionChangedPost(
  project.id,
  lot,
  position.id = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingPositionChangedPostWithHttpInfo()

Usage
SavingsApi$SapiV1LendingPositionChangedPostWithHttpInfo(
  project.id,
  lot,
  position.id = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingProjectListGet()

Usage
SavingsApi$SapiV1LendingProjectListGet(
  type,
  asset = NULL,
  status = NULL,
  is.sort.asc = NULL,
  sort.by = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingProjectListGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingProjectListGetWithHttpInfo(
  type,
  asset = NULL,
  status = NULL,
  is.sort.asc = NULL,
  sort.by = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingProjectPositionListGet()

Usage
SavingsApi$SapiV1LendingProjectPositionListGet(
  asset,
  project.id = NULL,
  status = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingProjectPositionListGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingProjectPositionListGetWithHttpInfo(
  asset,
  project.id = NULL,
  status = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingUnionAccountGet()

Usage
SavingsApi$SapiV1LendingUnionAccountGet(recv.window = NULL, ...)

Method SapiV1LendingUnionAccountGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingUnionAccountGetWithHttpInfo(recv.window = NULL, ...)

Method SapiV1LendingUnionInterestHistoryGet()

Usage
SavingsApi$SapiV1LendingUnionInterestHistoryGet(
  lending.type,
  asset = NULL,
  start.time = NULL,
  end.time = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingUnionInterestHistoryGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingUnionInterestHistoryGetWithHttpInfo(
  lending.type,
  asset = NULL,
  start.time = NULL,
  end.time = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingUnionPurchaseRecordGet()

Usage
SavingsApi$SapiV1LendingUnionPurchaseRecordGet(
  lending.type,
  asset = NULL,
  start.time = NULL,
  end.time = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingUnionPurchaseRecordGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingUnionPurchaseRecordGetWithHttpInfo(
  lending.type,
  asset = NULL,
  start.time = NULL,
  end.time = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingUnionRedemptionRecordGet()

Usage
SavingsApi$SapiV1LendingUnionRedemptionRecordGet(
  lending.type,
  asset = NULL,
  start.time = NULL,
  end.time = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method SapiV1LendingUnionRedemptionRecordGetWithHttpInfo()

Usage
SavingsApi$SapiV1LendingUnionRedemptionRecordGetWithHttpInfo(
  lending.type,
  asset = NULL,
  start.time = NULL,
  end.time = NULL,
  current = NULL,
  size = NULL,
  recv.window = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage
SavingsApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Not run: 
####################  SapiV1LendingCustomizedFixedPurchasePost  ####################

library(binanceRapi)
var.project.id <- 'project.id_example' # character | 
var.lot <- 'lot_example' # character | 
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Purchase Fixed/Activity Project (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingCustomizedFixedPurchasePost(var.project.id, var.lot, recv.window=var.recv.window)


####################  SapiV1LendingDailyProductListGet  ####################

library(binanceRapi)
var.status <- 'status_example' # character | Default `ALL`
var.featured <- 'featured_example' # character | Default `ALL`
var.current <- 1 # integer | Current querying page. Start from 1. Default:1
var.size <- 100 # integer | Default:10 Max:100
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Get Flexible Product List (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingDailyProductListGet(status=var.status, featured=var.featured, current=var.current, size=var.size, recv.window=var.recv.window)


####################  SapiV1LendingDailyPurchasePost  ####################

library(binanceRapi)
var.product.id <- 'product.id_example' # character | 
var.amount <- 1.01 # numeric | 
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Purchase Flexible Product (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingDailyPurchasePost(var.product.id, var.amount, recv.window=var.recv.window)


####################  SapiV1LendingDailyRedeemPost  ####################

library(binanceRapi)
var.product.id <- 'product.id_example' # character | 
var.amount <- 1.01 # numeric | 
var.type <- 'type_example' # character | 
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Redeem Flexible Product (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingDailyRedeemPost(var.product.id, var.amount, var.type, recv.window=var.recv.window)


####################  SapiV1LendingDailyTokenPositionGet  ####################

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

#Get Flexible Product Position (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingDailyTokenPositionGet(var.asset, recv.window=var.recv.window)


####################  SapiV1LendingDailyUserLeftQuotaGet  ####################

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

#Get Left Daily Purchase Quota of Flexible Product (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingDailyUserLeftQuotaGet(var.product.id, recv.window=var.recv.window)


####################  SapiV1LendingDailyUserRedemptionQuotaGet  ####################

library(binanceRapi)
var.product.id <- 'product.id_example' # character | 
var.type <- 'type_example' # character | 
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Get Left Daily Redemption Quota of Flexible Product (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingDailyUserRedemptionQuotaGet(var.product.id, var.type, recv.window=var.recv.window)


####################  SapiV1LendingPositionChangedPost  ####################

library(binanceRapi)
var.project.id <- 'project.id_example' # character | 
var.lot <- 'lot_example' # character | 
var.position.id <- 'position.id_example' # character | 
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Change Fixed/Activity Position to Daily Position (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingPositionChangedPost(var.project.id, var.lot, position.id=var.position.id, recv.window=var.recv.window)


####################  SapiV1LendingProjectListGet  ####################

library(binanceRapi)
var.type <- 'type_example' # character | 
var.asset <- 'BNB' # character | 
var.status <- 'status_example' # character | Default `ALL`
var.is.sort.asc <- 'is.sort.asc_example' # character | default \"true\"
var.sort.by <- 'sort.by_example' # character | Default `START_TIME`
var.current <- 1 # integer | Current querying page. Start from 1. Default:1
var.size <- 100 # integer | Default:10 Max:100
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Get Fixed/Activity Project List(USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingProjectListGet(var.type, asset=var.asset, status=var.status, is.sort.asc=var.is.sort.asc, sort.by=var.sort.by, current=var.current, size=var.size, recv.window=var.recv.window)


####################  SapiV1LendingProjectPositionListGet  ####################

library(binanceRapi)
var.asset <- 'BTC' # character | 
var.project.id <- 'project.id_example' # character | 
var.status <- 'status_example' # character | \"ALL\", \"SUBSCRIBABLE\", \"UNSUBSCRIBABLE\"; Default: 'ALL'
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Get Fixed/Activity Project Position (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingProjectPositionListGet(var.asset, project.id=var.project.id, status=var.status, recv.window=var.recv.window)


####################  SapiV1LendingUnionAccountGet  ####################

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

#Lending Account (USER_DATA)
api.instance <- SavingsApi$new()

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


####################  SapiV1LendingUnionInterestHistoryGet  ####################

library(binanceRapi)
var.lending.type <- 'lending.type_example' # character | * `DAILY` - for flexible * `ACTIVITY` - for activity * `CUSTOMIZED_FIXED` for fixed
var.asset <- 'BNB' # character | 
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.current <- 1 # integer | Current querying page. Start from 1. Default:1
var.size <- 100 # integer | Default:10 Max:100
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Get Interest History (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingUnionInterestHistoryGet(var.lending.type, asset=var.asset, start.time=var.start.time, end.time=var.end.time, current=var.current, size=var.size, recv.window=var.recv.window)


####################  SapiV1LendingUnionPurchaseRecordGet  ####################

library(binanceRapi)
var.lending.type <- 'lending.type_example' # character | * `DAILY` - for flexible * `ACTIVITY` - for activity * `CUSTOMIZED_FIXED` for fixed
var.asset <- 'BNB' # character | 
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.current <- 1 # integer | Current querying page. Start from 1. Default:1
var.size <- 100 # integer | Default:10 Max:100
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Get Purchase Record (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingUnionPurchaseRecordGet(var.lending.type, asset=var.asset, start.time=var.start.time, end.time=var.end.time, current=var.current, size=var.size, recv.window=var.recv.window)


####################  SapiV1LendingUnionRedemptionRecordGet  ####################

library(binanceRapi)
var.lending.type <- 'lending.type_example' # character | * `DAILY` - for flexible * `ACTIVITY` - for activity * `CUSTOMIZED_FIXED` for fixed
var.asset <- 'BNB' # character | 
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.current <- 1 # integer | Current querying page. Start from 1. Default:1
var.size <- 100 # integer | Default:10 Max:100
var.recv.window <- 5000 # integer | The value cannot be greater than 60000

#Get Redemption Record (USER_DATA)
api.instance <- SavingsApi$new()

result <- api.instance$SapiV1LendingUnionRedemptionRecordGet(var.lending.type, asset=var.asset, start.time=var.start.time, end.time=var.end.time, current=var.current, size=var.size, recv.window=var.recv.window)



## End(Not run)

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