docs/SubAccountApi.md
In grahamjwhite/binanceRapi: R Package Client for Binance Public Spot API
SubAccountApi
All URIs are relative to https://api.binance.com
Method | HTTP request | Description
------------- | ------------- | -------------
SapiV1CapitalDepositSubAddressGet | GET /sapi/v1/capital/deposit/subAddress | Sub-account Spot Assets Summary (For Master Account)
SapiV1CapitalDepositSubHisrecGet | GET /sapi/v1/capital/deposit/subHisrec | Sub-account Deposit History (For Master Account)
SapiV1ManagedSubaccountAssetGet | GET /sapi/v1/managed-subaccount/asset | Managed sub-account asset details（For Investor Master Account)
SapiV1ManagedSubaccountDepositPost | POST /sapi/v1/managed-subaccount/deposit | Deposit assets into the managed sub-account（For Investor Master Account）
SapiV1ManagedSubaccountWithdrawPost | POST /sapi/v1/managed-subaccount/withdraw | Withdrawl assets from the managed sub-account（For Investor Master Account)
SapiV1SubAccountBlvtEnablePost | POST /sapi/v1/sub-account/blvt/enable | Enable Leverage Token for Sub-account (For Master Account)
SapiV1SubAccountFuturesAccountGet | GET /sapi/v1/sub-account/futures/account | Detail on Sub-account's Futures Account (For Master Account)
SapiV1SubAccountFuturesAccountSummaryGet | GET /sapi/v1/sub-account/futures/accountSummary | Summary of Sub-account's Futures Account (For Master Account)
SapiV1SubAccountFuturesEnablePost | POST /sapi/v1/sub-account/futures/enable | Enable Futures for Sub-account (For Master Account)
SapiV1SubAccountFuturesInternalTransferGet | GET /sapi/v1/sub-account/futures/internalTransfer | Sub-account Futures Asset Transfer History (For Master Account)
SapiV1SubAccountFuturesInternalTransferPost | POST /sapi/v1/sub-account/futures/internalTransfer | Sub-account Futures Asset Transfer (For Master Account)
SapiV1SubAccountFuturesPositionRiskGet | GET /sapi/v1/sub-account/futures/positionRisk | Futures Position-Risk of Sub-account (For Master Account)
SapiV1SubAccountFuturesTransferPost | POST /sapi/v1/sub-account/futures/transfer | Transfer for Sub-account (For Master Account)
SapiV1SubAccountListGet | GET /sapi/v1/sub-account/list | Query Sub-account List (For Master Account)
SapiV1SubAccountMarginAccountGet | GET /sapi/v1/sub-account/margin/account | Detail on Sub-account's Margin Account (For Master Account)
SapiV1SubAccountMarginAccountSummaryGet | GET /sapi/v1/sub-account/margin/accountSummary | Summary of Sub-account's Margin Account (For Master Account)
SapiV1SubAccountMarginEnablePost | POST /sapi/v1/sub-account/margin/enable | Enable Margin for Sub-account (For Master Account)
SapiV1SubAccountMarginTransferPost | POST /sapi/v1/sub-account/margin/transfer | Margin Transfer for Sub-account (For Master Account)
SapiV1SubAccountSpotSummaryGet | GET /sapi/v1/sub-account/spotSummary | Sub-account Spot Assets Summary (For Master Account)
SapiV1SubAccountStatusGet | GET /sapi/v1/sub-account/status | Sub-account's Status on Margin/Futures (For Master Account)
SapiV1SubAccountSubTransferHistoryGet | GET /sapi/v1/sub-account/sub/transfer/history | Sub-account Spot Asset Transfer History (For Master Account)
SapiV1SubAccountTransferSubToMasterPost | POST /sapi/v1/sub-account/transfer/subToMaster | Transfer to Master (For Sub-account)
SapiV1SubAccountTransferSubToSubPost | POST /sapi/v1/sub-account/transfer/subToSub | Transfer to Sub-account of Same Master (For Sub-account)
SapiV1SubAccountTransferSubUserHistoryGet | GET /sapi/v1/sub-account/transfer/subUserHistory | Sub-account Transfer History (For Sub-account)
SapiV1SubAccountUniversalTransferGet | GET /sapi/v1/sub-account/universalTransfer | Universal Transfer History (For Master Account)
SapiV1SubAccountUniversalTransferPost | POST /sapi/v1/sub-account/universalTransfer | Universal Transfer (For Master Account)
SapiV1SubAccountVirtualSubAccountPost | POST /sapi/v1/sub-account/virtualSubAccount | Create a Virtual Sub-account(For Master Account)
SapiV2SubAccountFuturesAccountGet | GET /sapi/v2/sub-account/futures/account | Detail on Sub-account's Futures Account V2 (For Master Account)
SapiV2SubAccountFuturesAccountSummaryGet | GET /sapi/v2/sub-account/futures/accountSummary | Summary of Sub-account's Futures Account V2 (For Master Account)
SapiV2SubAccountFuturesPositionRiskGet | GET /sapi/v2/sub-account/futures/positionRisk | Futures Position-Risk of Sub-account V2 (For Master Account)
SapiV3SubAccountAssetsGet | GET /sapi/v3/sub-account/assets | Sub-account Assets (For Master Account)
SapiV1CapitalDepositSubAddressGet
InlineResponse20053 SapiV1CapitalDepositSubAddressGet(email, coin, timestamp, signature, network=var.network, recv.window=var.recv.window)
Sub-account Spot Assets Summary (For Master Account)
Fetch sub-account deposit address Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.coin <- 'BNB' # character | Coin name
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.network <- 'network_example' # character |
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Spot Assets Summary (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1CapitalDepositSubAddressGet(var.email, var.coin, var.timestamp, var.signature, network=var.network, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
coin | character| Coin name |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
network | character| | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Deposit address info | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1CapitalDepositSubHisrecGet
array[InlineResponse20054] SapiV1CapitalDepositSubHisrecGet(email, timestamp, signature, coin=var.coin, status=var.status, start.time=var.start.time, end.time=var.end.time, limit=var.limit, offset=var.offset, recv.window=var.recv.window)
Sub-account Deposit History (For Master Account)
Fetch sub-account deposit history Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.coin <- 'BNB' # character | Coin name
var.status <- 56 # integer | 0(0:pending,6: credited but cannot withdraw, 1:success)
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.limit <- 56 # integer |
var.offset <- 56 # integer |
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Deposit History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1CapitalDepositSubHisrecGet(var.email, var.timestamp, var.signature, coin=var.coin, status=var.status, start.time=var.start.time, end.time=var.end.time, limit=var.limit, offset=var.offset, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
coin | character| Coin name | [optional]
status | integer| 0(0:pending,6: credited but cannot withdraw, 1:success) | [optional]
start.time | integer| UTC timestamp in ms | [optional]
end.time | integer| UTC timestamp in ms | [optional]
limit | integer| | [optional]
offset | integer| | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Sub-account deposit history | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1ManagedSubaccountAssetGet
array[InlineResponse20069] SapiV1ManagedSubaccountAssetGet(email, timestamp, signature, recv.window=var.recv.window)
Managed sub-account asset details（For Investor Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Managed sub-account asset details（For Investor Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1ManagedSubaccountAssetGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | List of asset details | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1ManagedSubaccountDepositPost
InlineResponse20068 SapiV1ManagedSubaccountDepositPost(to.email, asset, amount, timestamp, signature, recv.window=var.recv.window)
Deposit assets into the managed sub-account（For Investor Master Account）
Weight(IP): 1
Example
library(binanceRapi)
var.to.email <- 'to.email_example' # character | Recipient email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Deposit assets into the managed sub-account（For Investor Master Account）
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1ManagedSubaccountDepositPost(var.to.email, var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
to.email | character| Recipient email |
asset | character| |
amount | numeric| |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1ManagedSubaccountWithdrawPost
InlineResponse20068 SapiV1ManagedSubaccountWithdrawPost(from.email, asset, amount, timestamp, signature, transfer.date=var.transfer.date, recv.window=var.recv.window)
Withdrawl assets from the managed sub-account（For Investor Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.from.email <- 'from.email_example' # character | Sender email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.transfer.date <- 56 # integer | Withdrawals is automatically occur on the transfer date(UTC0). If a date is not selected, the withdrawal occurs right now
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Withdrawl assets from the managed sub-account（For Investor Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1ManagedSubaccountWithdrawPost(var.from.email, var.asset, var.amount, var.timestamp, var.signature, transfer.date=var.transfer.date, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
from.email | character| Sender email |
asset | character| |
amount | numeric| |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
transfer.date | integer| Withdrawals is automatically occur on the transfer date(UTC0). If a date is not selected, the withdrawal occurs right now | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountBlvtEnablePost
InlineResponse20067 SapiV1SubAccountBlvtEnablePost(email, enable.blvt, timestamp, signature, recv.window=var.recv.window)
Enable Leverage Token for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.enable.blvt <- 'enable.blvt_example' # character | Only true for now
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Enable Leverage Token for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountBlvtEnablePost(var.email, var.enable.blvt, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
enable.blvt | character| Only true for now |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | BLVT status | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesAccountGet
InlineResponse20060 SapiV1SubAccountFuturesAccountGet(email, timestamp, signature, recv.window=var.recv.window)
Detail on Sub-account's Futures Account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Detail on Sub-account's Futures Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesAccountGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Futures account details | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesAccountSummaryGet
InlineResponse20061 SapiV1SubAccountFuturesAccountSummaryGet(timestamp, signature, recv.window=var.recv.window)
Summary of Sub-account's Futures Account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Summary of Sub-account's Futures Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesAccountSummaryGet(var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Futures account summary | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesEnablePost
InlineResponse20059 SapiV1SubAccountFuturesEnablePost(email, timestamp, signature, recv.window=var.recv.window)
Enable Futures for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Enable Futures for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesEnablePost(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Futures status | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesInternalTransferGet
InlineResponse20049 SapiV1SubAccountFuturesInternalTransferGet(email, futures.type, timestamp, signature, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
Sub-account Futures Asset Transfer History (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.futures.type <- 2 # integer | 1:USDT-margined Futures, 2: Coin-margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.page <- 1 # integer | Default 1
var.limit <- 56 # integer | Default value: 50, Max value: 500
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Futures Asset Transfer History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesInternalTransferGet(var.email, var.futures.type, var.timestamp, var.signature, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
futures.type | integer| 1:USDT-margined Futures, 2: Coin-margined Futures |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
start.time | integer| UTC timestamp in ms | [optional]
end.time | integer| UTC timestamp in ms | [optional]
page | integer| Default 1 | [optional]
limit | integer| Default value: 50, Max value: 500 | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Sub-account Futures Asset Transfer History | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesInternalTransferPost
InlineResponse20050 SapiV1SubAccountFuturesInternalTransferPost(from.email, to.email, futures.type, asset, amount, timestamp, signature, recv.window=var.recv.window)
Sub-account Futures Asset Transfer (For Master Account)
- Master account can transfer max 2000 times a minute Weight(IP): 1
Example
library(binanceRapi)
var.from.email <- 'from.email_example' # character | Sender email
var.to.email <- 'to.email_example' # character | Recipient email
var.futures.type <- 2 # integer | 1:USDT-margined Futures,2: Coin-margined Futures
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Futures Asset Transfer (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesInternalTransferPost(var.from.email, var.to.email, var.futures.type, var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
from.email | character| Sender email |
to.email | character| Recipient email |
futures.type | integer| 1:USDT-margined Futures,2: Coin-margined Futures |
asset | character| |
amount | numeric| |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Futures Asset Transfer Info | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesPositionRiskGet
array[InlineResponse20062] SapiV1SubAccountFuturesPositionRiskGet(email, timestamp, signature, recv.window=var.recv.window)
Futures Position-Risk of Sub-account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Futures Position-Risk of Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesPositionRiskGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Futures account summary | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesTransferPost
InlineResponse20063 SapiV1SubAccountFuturesTransferPost(email, asset, amount, type, timestamp, signature, recv.window=var.recv.window)
Transfer for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.type <- 56 # integer | 1: transfer from subaccount's spot account to its USDT-margined futures account 2: transfer from subaccount's USDT-margined futures account to its spot account 3: transfer from subaccount's spot account to its COIN-margined futures account 4:transfer from subaccount's COIN-margined futures account to its spot account
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Transfer for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesTransferPost(var.email, var.asset, var.amount, var.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
asset | character| |
amount | numeric| |
type | Enum [1, 2, 3, 4] | 1: transfer from subaccount's spot account to its USDT-margined futures account 2: transfer from subaccount's USDT-margined futures account to its spot account 3: transfer from subaccount's spot account to its COIN-margined futures account 4:transfer from subaccount's COIN-margined futures account to its spot account |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountListGet
InlineResponse20047 SapiV1SubAccountListGet(timestamp, signature, email=var.email, is.freeze=var.is.freeze, page=var.page, limit=var.limit, recv.window=var.recv.window)
Query Sub-account List (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.email <- 'email_example' # character | Sub-account email
var.is.freeze <- 'is.freeze_example' # character |
var.page <- 1 # integer | Default 1
var.limit <- 1 # integer | Default 1; max 200
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Query Sub-account List (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountListGet(var.timestamp, var.signature, email=var.email, is.freeze=var.is.freeze, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
email | character| Sub-account email | [optional]
is.freeze | Enum [true, false] | | [optional]
page | integer| Default 1 | [optional]
limit | integer| Default 1; max 200 | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | List of sub-accounts | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountMarginAccountGet
InlineResponse20057 SapiV1SubAccountMarginAccountGet(email, timestamp, signature, recv.window=var.recv.window)
Detail on Sub-account's Margin Account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Detail on Sub-account's Margin Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginAccountGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Margin sub-account details | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountMarginAccountSummaryGet
InlineResponse20058 SapiV1SubAccountMarginAccountSummaryGet(timestamp, signature, recv.window=var.recv.window)
Summary of Sub-account's Margin Account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Summary of Sub-account's Margin Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginAccountSummaryGet(var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Margin sub-account details | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountMarginEnablePost
InlineResponse20056 SapiV1SubAccountMarginEnablePost(email, timestamp, signature, recv.window=var.recv.window)
Enable Margin for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Enable Margin for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginEnablePost(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Margin status | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountMarginTransferPost
InlineResponse20063 SapiV1SubAccountMarginTransferPost(email, asset, amount, type, timestamp, signature, recv.window=var.recv.window)
Margin Transfer for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.type <- 56 # integer | 1: transfer from subaccount's spot account to margin account 2: transfer from subaccount's margin account to its spot account
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Margin Transfer for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginTransferPost(var.email, var.asset, var.amount, var.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
asset | character| |
amount | numeric| |
type | Enum [1, 2] | 1: transfer from subaccount's spot account to margin account 2: transfer from subaccount's margin account to its spot account |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountSpotSummaryGet
InlineResponse20052 SapiV1SubAccountSpotSummaryGet(email, timestamp, signature, page=var.page, size=var.size, recv.window=var.recv.window)
Sub-account Spot Assets Summary (For Master Account)
Get BTC valued asset summary of subaccounts. Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.page <- 1 # integer | Default 1
var.size <- 56 # integer | Default:10 Max:20
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Spot Assets Summary (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountSpotSummaryGet(var.email, var.timestamp, var.signature, page=var.page, size=var.size, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
page | integer| Default 1 | [optional]
size | integer| Default:10 Max:20 | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Summary of Sub-account Spot Assets | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountStatusGet
array[InlineResponse20055] SapiV1SubAccountStatusGet(timestamp, signature, email=var.email, recv.window=var.recv.window)
Sub-account's Status on Margin/Futures (For Master Account)
- If no
email sent, all sub-accounts' information will be returned. Weight(IP): 10
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.email <- 'email_example' # character | Sub-account email
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account's Status on Margin/Futures (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountStatusGet(var.timestamp, var.signature, email=var.email, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
email | character| Sub-account email | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Status on Margin/Futures | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountSubTransferHistoryGet
array[InlineResponse20048] SapiV1SubAccountSubTransferHistoryGet(timestamp, signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
Sub-account Spot Asset Transfer History (For Master Account)
- fromEmail and toEmail cannot be sent at the same time. - Return fromEmail equal master account email by default. Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.from.email <- 'from.email_example' # character | Sub-account email
var.to.email <- 'to.email_example' # character | Sub-account email
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.page <- 1 # integer | Default 1
var.limit <- 1 # integer | Default 1
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Spot Asset Transfer History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountSubTransferHistoryGet(var.timestamp, var.signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
from.email | character| Sub-account email | [optional]
to.email | character| Sub-account email | [optional]
start.time | integer| UTC timestamp in ms | [optional]
end.time | integer| UTC timestamp in ms | [optional]
page | integer| Default 1 | [optional]
limit | integer| Default 1 | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Sub-account Spot Asset Transfer History | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountTransferSubToMasterPost
InlineResponse20063 SapiV1SubAccountTransferSubToMasterPost(asset, amount, timestamp, signature, recv.window=var.recv.window)
Transfer to Master (For Sub-account)
Weight(IP): 1
Example
library(binanceRapi)
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Transfer to Master (For Sub-account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountTransferSubToMasterPost(var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
asset | character| |
amount | numeric| |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountTransferSubToSubPost
InlineResponse20063 SapiV1SubAccountTransferSubToSubPost(to.email, asset, amount, timestamp, signature, recv.window=var.recv.window)
Transfer to Sub-account of Same Master (For Sub-account)
Weight(IP): 1
Example
library(binanceRapi)
var.to.email <- 'to.email_example' # character | Recipient email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Transfer to Sub-account of Same Master (For Sub-account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountTransferSubToSubPost(var.to.email, var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
to.email | character| Recipient email |
asset | character| |
amount | numeric| |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountTransferSubUserHistoryGet
array[InlineResponse20064] SapiV1SubAccountTransferSubUserHistoryGet(timestamp, signature, asset=var.asset, type=var.type, start.time=var.start.time, end.time=var.end.time, limit=var.limit, recv.window=var.recv.window)
Sub-account Transfer History (For Sub-account)
- If
type is not sent, the records of type 2: transfer out will be returned by default. - If startTime and endTime are not sent, the recent 30-day data will be returned. Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.asset <- 'BNB' # character |
var.type <- 56 # integer | 1: transfer in 2: transfer out
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.limit <- 500 # integer | Default 500; max 1000.
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Transfer History (For Sub-account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountTransferSubUserHistoryGet(var.timestamp, var.signature, asset=var.asset, type=var.type, start.time=var.start.time, end.time=var.end.time, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
asset | character| | [optional]
type | Enum [1, 2] | 1: transfer in 2: transfer out | [optional]
start.time | integer| UTC timestamp in ms | [optional]
end.time | integer| UTC timestamp in ms | [optional]
limit | integer| Default 500; max 1000. | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountUniversalTransferGet
array[InlineResponse20065] SapiV1SubAccountUniversalTransferGet(timestamp, signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
Universal Transfer History (For Master Account)
- fromEmail and toEmail cannot be sent at the same time. - Return fromEmail equal master account email by default. - Only get the latest history of past 30 days. Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.from.email <- 'from.email_example' # character | Sub-account email
var.to.email <- 'to.email_example' # character | Sub-account email
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.page <- 1 # integer | Default 1
var.limit <- 'limit_example' # character | Default 500, Max 500
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Universal Transfer History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountUniversalTransferGet(var.timestamp, var.signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
from.email | character| Sub-account email | [optional]
to.email | character| Sub-account email | [optional]
start.time | integer| UTC timestamp in ms | [optional]
end.time | integer| UTC timestamp in ms | [optional]
page | integer| Default 1 | [optional]
limit | character| Default 500, Max 500 | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer History | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountUniversalTransferPost
InlineResponse20066 SapiV1SubAccountUniversalTransferPost(from.account.type, to.account.type, asset, amount, timestamp, signature, from.email=var.from.email, to.email=var.to.email, recv.window=var.recv.window)
Universal Transfer (For Master Account)
- You need to enable \"internal transfer\" option for the api key which requests this endpoint. - Transfer from master account by default if fromEmail is not sent. - Transfer to master account by default if toEmail is not sent. - Transfer between futures accounts is not supported. Weight(IP): 1
Example
library(binanceRapi)
var.from.account.type <- 'from.account.type_example' # character |
var.to.account.type <- 'to.account.type_example' # character |
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.from.email <- 'from.email_example' # character | Sub-account email
var.to.email <- 'to.email_example' # character | Sub-account email
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Universal Transfer (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountUniversalTransferPost(var.from.account.type, var.to.account.type, var.asset, var.amount, var.timestamp, var.signature, from.email=var.from.email, to.email=var.to.email, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
from.account.type | Enum [SPOT, USDT_FUTURE, COIN_FUTURE] | |
to.account.type | Enum [SPOT, USDT_FUTURE, COIN_FUTURE] | |
asset | character| |
amount | numeric| |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
from.email | character| Sub-account email | [optional]
to.email | character| Sub-account email | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Transfer id | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV1SubAccountVirtualSubAccountPost
InlineResponse20046 SapiV1SubAccountVirtualSubAccountPost(sub.account.string, timestamp, signature, recv.window=var.recv.window)
Create a Virtual Sub-account(For Master Account)
- This request will generate a virtual sub account under your master account. - You need to enable \"trade\" option for the api key which requests this endpoint. Weight(IP): 1
Example
library(binanceRapi)
var.sub.account.string <- 'sub.account.string_example' # character | Please input a string. We will create a virtual email using that string for you to register
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Create a Virtual Sub-account(For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountVirtualSubAccountPost(var.sub.account.string, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
sub.account.string | character| Please input a string. We will create a virtual email using that string for you to register |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | Return the created virtual email | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV2SubAccountFuturesAccountGet
OneOfsubAccountUSDTFuturesDetailssubAccountCOINFuturesDetails SapiV2SubAccountFuturesAccountGet(email, futures.type, timestamp, signature, recv.window=var.recv.window)
Detail on Sub-account's Futures Account V2 (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.futures.type <- 56 # integer | 1:USDT Margined Futures 2:COIN Margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Detail on Sub-account's Futures Account V2 (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV2SubAccountFuturesAccountGet(var.email, var.futures.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
futures.type | Enum [1, 2] | 1:USDT Margined Futures 2:COIN Margined Futures |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
OneOfsubAccountUSDTFuturesDetailssubAccountCOINFuturesDetails
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | USDT or COIN Margined Futures Details | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV2SubAccountFuturesAccountSummaryGet
OneOfsubAccountUSDTFuturesSummarysubAccountCOINFuturesSummary SapiV2SubAccountFuturesAccountSummaryGet(futures.type, timestamp, signature, page=var.page, limit=var.limit, recv.window=var.recv.window)
Summary of Sub-account's Futures Account V2 (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.futures.type <- 56 # integer | 1:USDT Margined Futures 2:COIN Margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.page <- 1 # integer | Default 1
var.limit <- 'limit_example' # character | Default 10, Max 20
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Summary of Sub-account's Futures Account V2 (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV2SubAccountFuturesAccountSummaryGet(var.futures.type, var.timestamp, var.signature, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
futures.type | Enum [1, 2] | 1:USDT Margined Futures 2:COIN Margined Futures |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
page | integer| Default 1 | [optional]
limit | character| Default 10, Max 20 | [optional]
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
OneOfsubAccountUSDTFuturesSummarysubAccountCOINFuturesSummary
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | USDT or COIN Margined Futures Summary | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV2SubAccountFuturesPositionRiskGet
OneOfsubAccountUSDTFuturesPositionRisksubAccountCOINFuturesPositionRisk SapiV2SubAccountFuturesPositionRiskGet(email, futures.type, timestamp, signature, recv.window=var.recv.window)
Futures Position-Risk of Sub-account V2 (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.futures.type <- 56 # integer | 1:USDT Margined Futures 2:COIN Margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Futures Position-Risk of Sub-account V2 (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV2SubAccountFuturesPositionRiskGet(var.email, var.futures.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
futures.type | Enum [1, 2] | 1:USDT Margined Futures 2:COIN Margined Futures |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
OneOfsubAccountUSDTFuturesPositionRisksubAccountCOINFuturesPositionRisk
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | USDT or COIN Margined Futures Position Risk | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
SapiV3SubAccountAssetsGet
InlineResponse20051 SapiV3SubAccountAssetsGet(email, timestamp, signature, recv.window=var.recv.window)
Sub-account Assets (For Master Account)
Fetch sub-account assets Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Assets (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV3SubAccountAssetsGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
email | character| Sub-account email |
timestamp | integer| UTC timestamp in ms |
signature | character| Signature |
recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| 200 | List of assets balances | - |
| 400 | Bad Request | - |
| 401 | Unauthorized Request | - |
grahamjwhite/binanceRapi documentation built on Nov. 22, 2022, 9:37 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
SubAccountApi
All URIs are relative to https://api.binance.com
Method | HTTP request | Description ------------- | ------------- | ------------- SapiV1CapitalDepositSubAddressGet | GET /sapi/v1/capital/deposit/subAddress | Sub-account Spot Assets Summary (For Master Account) SapiV1CapitalDepositSubHisrecGet | GET /sapi/v1/capital/deposit/subHisrec | Sub-account Deposit History (For Master Account) SapiV1ManagedSubaccountAssetGet | GET /sapi/v1/managed-subaccount/asset | Managed sub-account asset details（For Investor Master Account) SapiV1ManagedSubaccountDepositPost | POST /sapi/v1/managed-subaccount/deposit | Deposit assets into the managed sub-account（For Investor Master Account） SapiV1ManagedSubaccountWithdrawPost | POST /sapi/v1/managed-subaccount/withdraw | Withdrawl assets from the managed sub-account（For Investor Master Account) SapiV1SubAccountBlvtEnablePost | POST /sapi/v1/sub-account/blvt/enable | Enable Leverage Token for Sub-account (For Master Account) SapiV1SubAccountFuturesAccountGet | GET /sapi/v1/sub-account/futures/account | Detail on Sub-account's Futures Account (For Master Account) SapiV1SubAccountFuturesAccountSummaryGet | GET /sapi/v1/sub-account/futures/accountSummary | Summary of Sub-account's Futures Account (For Master Account) SapiV1SubAccountFuturesEnablePost | POST /sapi/v1/sub-account/futures/enable | Enable Futures for Sub-account (For Master Account) SapiV1SubAccountFuturesInternalTransferGet | GET /sapi/v1/sub-account/futures/internalTransfer | Sub-account Futures Asset Transfer History (For Master Account) SapiV1SubAccountFuturesInternalTransferPost | POST /sapi/v1/sub-account/futures/internalTransfer | Sub-account Futures Asset Transfer (For Master Account) SapiV1SubAccountFuturesPositionRiskGet | GET /sapi/v1/sub-account/futures/positionRisk | Futures Position-Risk of Sub-account (For Master Account) SapiV1SubAccountFuturesTransferPost | POST /sapi/v1/sub-account/futures/transfer | Transfer for Sub-account (For Master Account) SapiV1SubAccountListGet | GET /sapi/v1/sub-account/list | Query Sub-account List (For Master Account) SapiV1SubAccountMarginAccountGet | GET /sapi/v1/sub-account/margin/account | Detail on Sub-account's Margin Account (For Master Account) SapiV1SubAccountMarginAccountSummaryGet | GET /sapi/v1/sub-account/margin/accountSummary | Summary of Sub-account's Margin Account (For Master Account) SapiV1SubAccountMarginEnablePost | POST /sapi/v1/sub-account/margin/enable | Enable Margin for Sub-account (For Master Account) SapiV1SubAccountMarginTransferPost | POST /sapi/v1/sub-account/margin/transfer | Margin Transfer for Sub-account (For Master Account) SapiV1SubAccountSpotSummaryGet | GET /sapi/v1/sub-account/spotSummary | Sub-account Spot Assets Summary (For Master Account) SapiV1SubAccountStatusGet | GET /sapi/v1/sub-account/status | Sub-account's Status on Margin/Futures (For Master Account) SapiV1SubAccountSubTransferHistoryGet | GET /sapi/v1/sub-account/sub/transfer/history | Sub-account Spot Asset Transfer History (For Master Account) SapiV1SubAccountTransferSubToMasterPost | POST /sapi/v1/sub-account/transfer/subToMaster | Transfer to Master (For Sub-account) SapiV1SubAccountTransferSubToSubPost | POST /sapi/v1/sub-account/transfer/subToSub | Transfer to Sub-account of Same Master (For Sub-account) SapiV1SubAccountTransferSubUserHistoryGet | GET /sapi/v1/sub-account/transfer/subUserHistory | Sub-account Transfer History (For Sub-account) SapiV1SubAccountUniversalTransferGet | GET /sapi/v1/sub-account/universalTransfer | Universal Transfer History (For Master Account) SapiV1SubAccountUniversalTransferPost | POST /sapi/v1/sub-account/universalTransfer | Universal Transfer (For Master Account) SapiV1SubAccountVirtualSubAccountPost | POST /sapi/v1/sub-account/virtualSubAccount | Create a Virtual Sub-account(For Master Account) SapiV2SubAccountFuturesAccountGet | GET /sapi/v2/sub-account/futures/account | Detail on Sub-account's Futures Account V2 (For Master Account) SapiV2SubAccountFuturesAccountSummaryGet | GET /sapi/v2/sub-account/futures/accountSummary | Summary of Sub-account's Futures Account V2 (For Master Account) SapiV2SubAccountFuturesPositionRiskGet | GET /sapi/v2/sub-account/futures/positionRisk | Futures Position-Risk of Sub-account V2 (For Master Account) SapiV3SubAccountAssetsGet | GET /sapi/v3/sub-account/assets | Sub-account Assets (For Master Account)
SapiV1CapitalDepositSubAddressGet
InlineResponse20053 SapiV1CapitalDepositSubAddressGet(email, coin, timestamp, signature, network=var.network, recv.window=var.recv.window)
Sub-account Spot Assets Summary (For Master Account)
Fetch sub-account deposit address Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.coin <- 'BNB' # character | Coin name
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.network <- 'network_example' # character |
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Spot Assets Summary (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1CapitalDepositSubAddressGet(var.email, var.coin, var.timestamp, var.signature, network=var.network, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | coin | character| Coin name | timestamp | integer| UTC timestamp in ms | signature | character| Signature | network | character| | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Deposit address info | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1CapitalDepositSubHisrecGet
array[InlineResponse20054] SapiV1CapitalDepositSubHisrecGet(email, timestamp, signature, coin=var.coin, status=var.status, start.time=var.start.time, end.time=var.end.time, limit=var.limit, offset=var.offset, recv.window=var.recv.window)
Sub-account Deposit History (For Master Account)
Fetch sub-account deposit history Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.coin <- 'BNB' # character | Coin name
var.status <- 56 # integer | 0(0:pending,6: credited but cannot withdraw, 1:success)
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.limit <- 56 # integer |
var.offset <- 56 # integer |
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Deposit History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1CapitalDepositSubHisrecGet(var.email, var.timestamp, var.signature, coin=var.coin, status=var.status, start.time=var.start.time, end.time=var.end.time, limit=var.limit, offset=var.offset, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | coin | character| Coin name | [optional] status | integer| 0(0:pending,6: credited but cannot withdraw, 1:success) | [optional] start.time | integer| UTC timestamp in ms | [optional] end.time | integer| UTC timestamp in ms | [optional] limit | integer| | [optional] offset | integer| | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Sub-account deposit history | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1ManagedSubaccountAssetGet
array[InlineResponse20069] SapiV1ManagedSubaccountAssetGet(email, timestamp, signature, recv.window=var.recv.window)
Managed sub-account asset details（For Investor Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Managed sub-account asset details（For Investor Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1ManagedSubaccountAssetGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | List of asset details | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1ManagedSubaccountDepositPost
InlineResponse20068 SapiV1ManagedSubaccountDepositPost(to.email, asset, amount, timestamp, signature, recv.window=var.recv.window)
Deposit assets into the managed sub-account（For Investor Master Account）
Weight(IP): 1
Example
library(binanceRapi)
var.to.email <- 'to.email_example' # character | Recipient email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Deposit assets into the managed sub-account（For Investor Master Account）
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1ManagedSubaccountDepositPost(var.to.email, var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- to.email | character| Recipient email | asset | character| | amount | numeric| | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1ManagedSubaccountWithdrawPost
InlineResponse20068 SapiV1ManagedSubaccountWithdrawPost(from.email, asset, amount, timestamp, signature, transfer.date=var.transfer.date, recv.window=var.recv.window)
Withdrawl assets from the managed sub-account（For Investor Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.from.email <- 'from.email_example' # character | Sender email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.transfer.date <- 56 # integer | Withdrawals is automatically occur on the transfer date(UTC0). If a date is not selected, the withdrawal occurs right now
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Withdrawl assets from the managed sub-account（For Investor Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1ManagedSubaccountWithdrawPost(var.from.email, var.asset, var.amount, var.timestamp, var.signature, transfer.date=var.transfer.date, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- from.email | character| Sender email | asset | character| | amount | numeric| | timestamp | integer| UTC timestamp in ms | signature | character| Signature | transfer.date | integer| Withdrawals is automatically occur on the transfer date(UTC0). If a date is not selected, the withdrawal occurs right now | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountBlvtEnablePost
InlineResponse20067 SapiV1SubAccountBlvtEnablePost(email, enable.blvt, timestamp, signature, recv.window=var.recv.window)
Enable Leverage Token for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.enable.blvt <- 'enable.blvt_example' # character | Only true for now
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Enable Leverage Token for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountBlvtEnablePost(var.email, var.enable.blvt, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | enable.blvt | character| Only true for now | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | BLVT status | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesAccountGet
InlineResponse20060 SapiV1SubAccountFuturesAccountGet(email, timestamp, signature, recv.window=var.recv.window)
Detail on Sub-account's Futures Account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Detail on Sub-account's Futures Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesAccountGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Futures account details | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesAccountSummaryGet
InlineResponse20061 SapiV1SubAccountFuturesAccountSummaryGet(timestamp, signature, recv.window=var.recv.window)
Summary of Sub-account's Futures Account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Summary of Sub-account's Futures Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesAccountSummaryGet(var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Futures account summary | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesEnablePost
InlineResponse20059 SapiV1SubAccountFuturesEnablePost(email, timestamp, signature, recv.window=var.recv.window)
Enable Futures for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Enable Futures for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesEnablePost(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Futures status | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesInternalTransferGet
InlineResponse20049 SapiV1SubAccountFuturesInternalTransferGet(email, futures.type, timestamp, signature, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
Sub-account Futures Asset Transfer History (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.futures.type <- 2 # integer | 1:USDT-margined Futures, 2: Coin-margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.page <- 1 # integer | Default 1
var.limit <- 56 # integer | Default value: 50, Max value: 500
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Futures Asset Transfer History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesInternalTransferGet(var.email, var.futures.type, var.timestamp, var.signature, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | futures.type | integer| 1:USDT-margined Futures, 2: Coin-margined Futures | timestamp | integer| UTC timestamp in ms | signature | character| Signature | start.time | integer| UTC timestamp in ms | [optional] end.time | integer| UTC timestamp in ms | [optional] page | integer| Default 1 | [optional] limit | integer| Default value: 50, Max value: 500 | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Sub-account Futures Asset Transfer History | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesInternalTransferPost
InlineResponse20050 SapiV1SubAccountFuturesInternalTransferPost(from.email, to.email, futures.type, asset, amount, timestamp, signature, recv.window=var.recv.window)
Sub-account Futures Asset Transfer (For Master Account)
- Master account can transfer max 2000 times a minute Weight(IP): 1
Example
library(binanceRapi)
var.from.email <- 'from.email_example' # character | Sender email
var.to.email <- 'to.email_example' # character | Recipient email
var.futures.type <- 2 # integer | 1:USDT-margined Futures,2: Coin-margined Futures
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Futures Asset Transfer (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesInternalTransferPost(var.from.email, var.to.email, var.futures.type, var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- from.email | character| Sender email | to.email | character| Recipient email | futures.type | integer| 1:USDT-margined Futures,2: Coin-margined Futures | asset | character| | amount | numeric| | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Futures Asset Transfer Info | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesPositionRiskGet
array[InlineResponse20062] SapiV1SubAccountFuturesPositionRiskGet(email, timestamp, signature, recv.window=var.recv.window)
Futures Position-Risk of Sub-account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Futures Position-Risk of Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesPositionRiskGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Futures account summary | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountFuturesTransferPost
InlineResponse20063 SapiV1SubAccountFuturesTransferPost(email, asset, amount, type, timestamp, signature, recv.window=var.recv.window)
Transfer for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.type <- 56 # integer | 1: transfer from subaccount's spot account to its USDT-margined futures account 2: transfer from subaccount's USDT-margined futures account to its spot account 3: transfer from subaccount's spot account to its COIN-margined futures account 4:transfer from subaccount's COIN-margined futures account to its spot account
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Transfer for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountFuturesTransferPost(var.email, var.asset, var.amount, var.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | asset | character| | amount | numeric| | type | Enum [1, 2, 3, 4] | 1: transfer from subaccount's spot account to its USDT-margined futures account 2: transfer from subaccount's USDT-margined futures account to its spot account 3: transfer from subaccount's spot account to its COIN-margined futures account 4:transfer from subaccount's COIN-margined futures account to its spot account | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountListGet
InlineResponse20047 SapiV1SubAccountListGet(timestamp, signature, email=var.email, is.freeze=var.is.freeze, page=var.page, limit=var.limit, recv.window=var.recv.window)
Query Sub-account List (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.email <- 'email_example' # character | Sub-account email
var.is.freeze <- 'is.freeze_example' # character |
var.page <- 1 # integer | Default 1
var.limit <- 1 # integer | Default 1; max 200
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Query Sub-account List (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountListGet(var.timestamp, var.signature, email=var.email, is.freeze=var.is.freeze, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- timestamp | integer| UTC timestamp in ms | signature | character| Signature | email | character| Sub-account email | [optional] is.freeze | Enum [true, false] | | [optional] page | integer| Default 1 | [optional] limit | integer| Default 1; max 200 | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | List of sub-accounts | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountMarginAccountGet
InlineResponse20057 SapiV1SubAccountMarginAccountGet(email, timestamp, signature, recv.window=var.recv.window)
Detail on Sub-account's Margin Account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Detail on Sub-account's Margin Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginAccountGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Margin sub-account details | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountMarginAccountSummaryGet
InlineResponse20058 SapiV1SubAccountMarginAccountSummaryGet(timestamp, signature, recv.window=var.recv.window)
Summary of Sub-account's Margin Account (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Summary of Sub-account's Margin Account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginAccountSummaryGet(var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Margin sub-account details | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountMarginEnablePost
InlineResponse20056 SapiV1SubAccountMarginEnablePost(email, timestamp, signature, recv.window=var.recv.window)
Enable Margin for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Enable Margin for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginEnablePost(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Margin status | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountMarginTransferPost
InlineResponse20063 SapiV1SubAccountMarginTransferPost(email, asset, amount, type, timestamp, signature, recv.window=var.recv.window)
Margin Transfer for Sub-account (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.type <- 56 # integer | 1: transfer from subaccount's spot account to margin account 2: transfer from subaccount's margin account to its spot account
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Margin Transfer for Sub-account (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountMarginTransferPost(var.email, var.asset, var.amount, var.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | asset | character| | amount | numeric| | type | Enum [1, 2] | 1: transfer from subaccount's spot account to margin account 2: transfer from subaccount's margin account to its spot account | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountSpotSummaryGet
InlineResponse20052 SapiV1SubAccountSpotSummaryGet(email, timestamp, signature, page=var.page, size=var.size, recv.window=var.recv.window)
Sub-account Spot Assets Summary (For Master Account)
Get BTC valued asset summary of subaccounts. Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.page <- 1 # integer | Default 1
var.size <- 56 # integer | Default:10 Max:20
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Spot Assets Summary (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountSpotSummaryGet(var.email, var.timestamp, var.signature, page=var.page, size=var.size, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | page | integer| Default 1 | [optional] size | integer| Default:10 Max:20 | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Summary of Sub-account Spot Assets | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountStatusGet
array[InlineResponse20055] SapiV1SubAccountStatusGet(timestamp, signature, email=var.email, recv.window=var.recv.window)
Sub-account's Status on Margin/Futures (For Master Account)
- If no
emailsent, all sub-accounts' information will be returned. Weight(IP): 10
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.email <- 'email_example' # character | Sub-account email
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account's Status on Margin/Futures (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountStatusGet(var.timestamp, var.signature, email=var.email, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- timestamp | integer| UTC timestamp in ms | signature | character| Signature | email | character| Sub-account email | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Status on Margin/Futures | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountSubTransferHistoryGet
array[InlineResponse20048] SapiV1SubAccountSubTransferHistoryGet(timestamp, signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
Sub-account Spot Asset Transfer History (For Master Account)
- fromEmail and toEmail cannot be sent at the same time. - Return fromEmail equal master account email by default. Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.from.email <- 'from.email_example' # character | Sub-account email
var.to.email <- 'to.email_example' # character | Sub-account email
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.page <- 1 # integer | Default 1
var.limit <- 1 # integer | Default 1
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Spot Asset Transfer History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountSubTransferHistoryGet(var.timestamp, var.signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- timestamp | integer| UTC timestamp in ms | signature | character| Signature | from.email | character| Sub-account email | [optional] to.email | character| Sub-account email | [optional] start.time | integer| UTC timestamp in ms | [optional] end.time | integer| UTC timestamp in ms | [optional] page | integer| Default 1 | [optional] limit | integer| Default 1 | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Sub-account Spot Asset Transfer History | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountTransferSubToMasterPost
InlineResponse20063 SapiV1SubAccountTransferSubToMasterPost(asset, amount, timestamp, signature, recv.window=var.recv.window)
Transfer to Master (For Sub-account)
Weight(IP): 1
Example
library(binanceRapi)
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Transfer to Master (For Sub-account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountTransferSubToMasterPost(var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- asset | character| | amount | numeric| | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountTransferSubToSubPost
InlineResponse20063 SapiV1SubAccountTransferSubToSubPost(to.email, asset, amount, timestamp, signature, recv.window=var.recv.window)
Transfer to Sub-account of Same Master (For Sub-account)
Weight(IP): 1
Example
library(binanceRapi)
var.to.email <- 'to.email_example' # character | Recipient email
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Transfer to Sub-account of Same Master (For Sub-account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountTransferSubToSubPost(var.to.email, var.asset, var.amount, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- to.email | character| Recipient email | asset | character| | amount | numeric| | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountTransferSubUserHistoryGet
array[InlineResponse20064] SapiV1SubAccountTransferSubUserHistoryGet(timestamp, signature, asset=var.asset, type=var.type, start.time=var.start.time, end.time=var.end.time, limit=var.limit, recv.window=var.recv.window)
Sub-account Transfer History (For Sub-account)
- If
typeis not sent, the records of type 2: transfer out will be returned by default. - IfstartTimeandendTimeare not sent, the recent 30-day data will be returned. Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.asset <- 'BNB' # character |
var.type <- 56 # integer | 1: transfer in 2: transfer out
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.limit <- 500 # integer | Default 500; max 1000.
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Transfer History (For Sub-account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountTransferSubUserHistoryGet(var.timestamp, var.signature, asset=var.asset, type=var.type, start.time=var.start.time, end.time=var.end.time, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- timestamp | integer| UTC timestamp in ms | signature | character| Signature | asset | character| | [optional] type | Enum [1, 2] | 1: transfer in 2: transfer out | [optional] start.time | integer| UTC timestamp in ms | [optional] end.time | integer| UTC timestamp in ms | [optional] limit | integer| Default 500; max 1000. | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountUniversalTransferGet
array[InlineResponse20065] SapiV1SubAccountUniversalTransferGet(timestamp, signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
Universal Transfer History (For Master Account)
- fromEmail and toEmail cannot be sent at the same time. - Return fromEmail equal master account email by default. - Only get the latest history of past 30 days. Weight(IP): 1
Example
library(binanceRapi)
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.from.email <- 'from.email_example' # character | Sub-account email
var.to.email <- 'to.email_example' # character | Sub-account email
var.start.time <- 56 # integer | UTC timestamp in ms
var.end.time <- 56 # integer | UTC timestamp in ms
var.page <- 1 # integer | Default 1
var.limit <- 'limit_example' # character | Default 500, Max 500
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Universal Transfer History (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountUniversalTransferGet(var.timestamp, var.signature, from.email=var.from.email, to.email=var.to.email, start.time=var.start.time, end.time=var.end.time, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- timestamp | integer| UTC timestamp in ms | signature | character| Signature | from.email | character| Sub-account email | [optional] to.email | character| Sub-account email | [optional] start.time | integer| UTC timestamp in ms | [optional] end.time | integer| UTC timestamp in ms | [optional] page | integer| Default 1 | [optional] limit | character| Default 500, Max 500 | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer History | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountUniversalTransferPost
InlineResponse20066 SapiV1SubAccountUniversalTransferPost(from.account.type, to.account.type, asset, amount, timestamp, signature, from.email=var.from.email, to.email=var.to.email, recv.window=var.recv.window)
Universal Transfer (For Master Account)
- You need to enable \"internal transfer\" option for the api key which requests this endpoint. - Transfer from master account by default if fromEmail is not sent. - Transfer to master account by default if toEmail is not sent. - Transfer between futures accounts is not supported. Weight(IP): 1
Example
library(binanceRapi)
var.from.account.type <- 'from.account.type_example' # character |
var.to.account.type <- 'to.account.type_example' # character |
var.asset <- 'BTC' # character |
var.amount <- 1.01 # numeric |
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.from.email <- 'from.email_example' # character | Sub-account email
var.to.email <- 'to.email_example' # character | Sub-account email
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Universal Transfer (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountUniversalTransferPost(var.from.account.type, var.to.account.type, var.asset, var.amount, var.timestamp, var.signature, from.email=var.from.email, to.email=var.to.email, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- from.account.type | Enum [SPOT, USDT_FUTURE, COIN_FUTURE] | | to.account.type | Enum [SPOT, USDT_FUTURE, COIN_FUTURE] | | asset | character| | amount | numeric| | timestamp | integer| UTC timestamp in ms | signature | character| Signature | from.email | character| Sub-account email | [optional] to.email | character| Sub-account email | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Transfer id | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV1SubAccountVirtualSubAccountPost
InlineResponse20046 SapiV1SubAccountVirtualSubAccountPost(sub.account.string, timestamp, signature, recv.window=var.recv.window)
Create a Virtual Sub-account(For Master Account)
- This request will generate a virtual sub account under your master account. - You need to enable \"trade\" option for the api key which requests this endpoint. Weight(IP): 1
Example
library(binanceRapi)
var.sub.account.string <- 'sub.account.string_example' # character | Please input a string. We will create a virtual email using that string for you to register
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Create a Virtual Sub-account(For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV1SubAccountVirtualSubAccountPost(var.sub.account.string, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- sub.account.string | character| Please input a string. We will create a virtual email using that string for you to register | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | Return the created virtual email | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV2SubAccountFuturesAccountGet
OneOfsubAccountUSDTFuturesDetailssubAccountCOINFuturesDetails SapiV2SubAccountFuturesAccountGet(email, futures.type, timestamp, signature, recv.window=var.recv.window)
Detail on Sub-account's Futures Account V2 (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.futures.type <- 56 # integer | 1:USDT Margined Futures 2:COIN Margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Detail on Sub-account's Futures Account V2 (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV2SubAccountFuturesAccountGet(var.email, var.futures.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | futures.type | Enum [1, 2] | 1:USDT Margined Futures 2:COIN Margined Futures | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
OneOfsubAccountUSDTFuturesDetailssubAccountCOINFuturesDetails
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | USDT or COIN Margined Futures Details | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV2SubAccountFuturesAccountSummaryGet
OneOfsubAccountUSDTFuturesSummarysubAccountCOINFuturesSummary SapiV2SubAccountFuturesAccountSummaryGet(futures.type, timestamp, signature, page=var.page, limit=var.limit, recv.window=var.recv.window)
Summary of Sub-account's Futures Account V2 (For Master Account)
Weight(IP): 10
Example
library(binanceRapi)
var.futures.type <- 56 # integer | 1:USDT Margined Futures 2:COIN Margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.page <- 1 # integer | Default 1
var.limit <- 'limit_example' # character | Default 10, Max 20
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Summary of Sub-account's Futures Account V2 (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV2SubAccountFuturesAccountSummaryGet(var.futures.type, var.timestamp, var.signature, page=var.page, limit=var.limit, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- futures.type | Enum [1, 2] | 1:USDT Margined Futures 2:COIN Margined Futures | timestamp | integer| UTC timestamp in ms | signature | character| Signature | page | integer| Default 1 | [optional] limit | character| Default 10, Max 20 | [optional] recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
OneOfsubAccountUSDTFuturesSummarysubAccountCOINFuturesSummary
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | USDT or COIN Margined Futures Summary | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV2SubAccountFuturesPositionRiskGet
OneOfsubAccountUSDTFuturesPositionRisksubAccountCOINFuturesPositionRisk SapiV2SubAccountFuturesPositionRiskGet(email, futures.type, timestamp, signature, recv.window=var.recv.window)
Futures Position-Risk of Sub-account V2 (For Master Account)
Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.futures.type <- 56 # integer | 1:USDT Margined Futures 2:COIN Margined Futures
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Futures Position-Risk of Sub-account V2 (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV2SubAccountFuturesPositionRiskGet(var.email, var.futures.type, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | futures.type | Enum [1, 2] | 1:USDT Margined Futures 2:COIN Margined Futures | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
OneOfsubAccountUSDTFuturesPositionRisksubAccountCOINFuturesPositionRisk
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | USDT or COIN Margined Futures Position Risk | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
SapiV3SubAccountAssetsGet
InlineResponse20051 SapiV3SubAccountAssetsGet(email, timestamp, signature, recv.window=var.recv.window)
Sub-account Assets (For Master Account)
Fetch sub-account assets Weight(IP): 1
Example
library(binanceRapi)
var.email <- 'email_example' # character | Sub-account email
var.timestamp <- 56 # integer | UTC timestamp in ms
var.signature <- 'signature_example' # character | Signature
var.recv.window <- 5000 # integer | The value cannot be greater than 60000
#Sub-account Assets (For Master Account)
api.instance <- SubAccountApi$new()
# Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY';
result <- api.instance$SapiV3SubAccountAssetsGet(var.email, var.timestamp, var.signature, recv.window=var.recv.window)
dput(result)
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- email | character| Sub-account email | timestamp | integer| UTC timestamp in ms | signature | character| Signature | recv.window | integer| The value cannot be greater than 60000 | [optional]
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |-------------|-------------|------------------| | 200 | List of assets balances | - | | 400 | Bad Request | - | | 401 | Unauthorized Request | - |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.