@spec get_simple_earn_account(recvWindow: any(), timestamp: any()) ::
  {:ok, any()} | {:error, any()}

Simple Account (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/account

Mandatory params:

Optional params:

• timestamp - timestamp
• recvWindow - no more than 60000

@spec get_simple_earn_flexible_history_collateral_record(
  recvWindow: any(),
  size: any(),
  current: any(),
  endTime: any(),
  startTime: any(),
  productId: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Collateral Record (USER_DATA)

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight(IP): 1

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/history/collateralRecord

Mandatory params:

Optional params:

• timestamp - timestamp
• productId -
• startTime -
• endTime -
• current -
• size -
• recvWindow - no more than 60000

@spec get_simple_earn_flexible_history_rate_history(any(),
  recvWindow: any(),
  size: any(),
  current: any(),
  endTime: any(),
  startTime: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Rate History (USER_DATA)

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/history/rateHistory

Mandatory params:

• productId -

Optional params:

• timestamp - timestamp
• startTime -
• endTime -
• current - Currently querying page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_flexible_history_redemption_record(
  size: any(),
  current: any(),
  endTime: any(),
  startTime: any(),
  asset: any(),
  redeemId: any(),
  productId: any()
) :: {:ok, any()} | {:error, any()}

Get Flexible Redemption Record (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/history/redemptionRecord

Mandatory params:

Optional params:

• productId -
• redeemId -
• asset -
• startTime -
• endTime -
• current - Currently querying the page. Start from 1. Default:1
• size - Default:10, Max:100

@spec get_simple_earn_flexible_history_rewards_record(
  type: any(),
  endTime: any(),
  startTime: any(),
  asset: any(),
  productId: any()
) :: {:ok, any()} | {:error, any()}

Get Flexible Rewards History (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/history/rewardsRecord

Mandatory params:

Optional params:

• productId -
• asset -
• startTime -
• endTime -
• type - BONUS, REALTIME, REWARDS

@spec get_simple_earn_flexible_history_subscription_record(
  recvWindow: any(),
  size: any(),
  current: any(),
  endTime: any(),
  startTime: any(),
  asset: any(),
  purchaseId: any(),
  productId: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Flexible Subscription Record (USER_DATA)

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/history/subscriptionRecord

Mandatory params:

Optional params:

• timestamp - timestamp
• productId -
• purchaseId -
• asset -
• startTime -
• endTime -
• current - Currently querying the page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_flexible_list(
  recvWindow: any(),
  size: any(),
  current: any(),
  asset: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Simple Earn Flexible Product List (USER_DATA)

Get available Simple Earn flexible product list

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/list

Mandatory params:

Optional params:

• timestamp - timestamp
• asset -
• current - Currently querying page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_flexible_personal_left_quota(any(),
  recvWindow: any(),
  timestamp: any()
) ::
  {:ok, any()} | {:error, any()}

Get Flexible Personal Left Quota (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/personalLeftQuota

Mandatory params:

• productId -

Optional params:

• timestamp - timestamp
• recvWindow - no more than 60000

@spec get_simple_earn_flexible_position(
  recvWindow: any(),
  size: any(),
  current: any(),
  productId: any(),
  asset: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Flexible Product Position (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/position

Mandatory params:

Optional params:

• timestamp - timestamp
• asset -
• productId -
• current - Currently querying the page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_flexible_subscription_preview(any(), any(),
  recvWindow: any(),
  timestamp: any()
) ::
  {:ok, any()} | {:error, any()}

Get Flexible Subscription Preview (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/flexible/subscriptionPreview

Mandatory params:

• productId -
• amount -

Optional params:

• timestamp - timestamp
• recvWindow - no more than 60000

@spec get_simple_earn_locked_history_redemption_record(
  recvWindow: any(),
  size: any(),
  current: any(),
  endTime: any(),
  startTime: any(),
  asset: any(),
  positionId: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Locked Rewards History (USER_DATA)

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/locked/history/redemptionRecord

Mandatory params:

Optional params:

• timestamp - timestamp
• positionId -
• asset -
• startTime -
• endTime -
• current - Currently querying the page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_locked_history_subscription_record(
  recvWindow: any(),
  size: any(),
  current: any(),
  endTime: any(),
  startTime: any(),
  asset: any(),
  purchaseId: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Locked Subscription Record (USER_DATA)

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/locked/history/subscriptionRecord

Mandatory params:

Optional params:

• timestamp - timestamp
• purchaseId -
• asset -
• startTime -
• endTime -
• current - Currently querying the page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_locked_list(
  recvWindow: any(),
  size: any(),
  current: any(),
  asset: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Simple Earn Locked Product List (USER_DATA)

Get available Simple Earn locked product list

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/locked/list

Mandatory params:

Optional params:

• timestamp - timestamp
• asset -
• current - Currently querying page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_locked_personal_left_quota(any(),
  recvWindow: any(),
  timestamp: any()
) ::
  {:ok, any()} | {:error, any()}

Get Locked Personal Left Quota (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/locked/personalLeftQuota

Mandatory params:

• projectId -

Optional params:

• timestamp - timestamp
• recvWindow - no more than 60000

@spec get_simple_earn_locked_position(
  recvWindow: any(),
  size: any(),
  current: any(),
  projectId: any(),
  positionId: any(),
  asset: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Locked Product Position (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/locked/position

Mandatory params:

Optional params:

• timestamp - timestamp
• asset -
• positionId -
• projectId -
• current - Currently querying the page. Start from 1. Default:1
• size - Default:10, Max:100
• recvWindow - no more than 60000

@spec get_simple_earn_locked_subscription_preview(any(), any(),
  recvWindow: any(),
  autoSubscribe: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Locked Subscription Preview (USER_DATA)

Weight(IP): 150

Details:

• METHOD: get
• URL: /sapi/v1/simple-earn/locked/subscriptionPreview

Mandatory params:

• projectId -
• amount -

Optional params:

• timestamp - timestamp
• autoSubscribe - true or false, default true.
• recvWindow - no more than 60000

@spec post_simple_earn_flexible_redeem(any(),
  recvWindow: any(),
  amount: any(),
  redeemAll: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Redeem Flexible Product (TRADE)

Rate Limit: 1/3s per account

You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.

Weight(IP): 1

Details:

• METHOD: post
• URL: /sapi/v1/simple-earn/flexible/redeem

Mandatory params:

• productId -

Optional params:

• timestamp - timestamp
• redeemAll - true or false, default to false
• amount - if redeemAll is false, amount is mandatory
• recvWindow - no more than 60000

@spec post_simple_earn_flexible_set_auto_subscribe(any(), any(),
  recvWindow: any(),
  timestamp: any()
) ::
  {:ok, any()} | {:error, any()}

Set Flexible Auto Subscribe (USER_DATA)

Weight(IP): 150

Details:

• METHOD: post
• URL: /sapi/v1/simple-earn/flexible/setAutoSubscribe

Mandatory params:

• productId -
• autoSubscribe - true or false

Optional params:

• timestamp - timestamp
• recvWindow - no more than 60000

@spec post_simple_earn_flexible_subscribe(any(), any(),
  recvWindow: any(),
  autoSubscribe: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Subscribe Flexible Product (TRADE)

Rate Limit: 1/3s per account

You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.

Weight(IP): 1

Details:

• METHOD: post
• URL: /sapi/v1/simple-earn/flexible/subscribe

Mandatory params:

• productId -
• amount -

Optional params:

• timestamp - timestamp
• autoSubscribe - true or false, default true
• recvWindow - no more than 60000

@spec post_simple_earn_locked_redeem(any(), recvWindow: any(), timestamp: any()) ::
  {:ok, any()} | {:error, any()}

Redeem Locked Product (TRADE)

Rate Limit: 1/3s per account

You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint

Weight(IP): 1

Details:

• METHOD: post
• URL: /sapi/v1/simple-earn/locked/redeem

Mandatory params:

• positionId - eg. 1234

Optional params:

• timestamp - timestamp
• recvWindow - no more than 60000

@spec post_simple_earn_locked_set_auto_subscribe(any(), any(),
  recvWindow: any(),
  timestamp: any()
) ::
  {:ok, any()} | {:error, any()}

Set Locked Auto Subscribe (USER_DATA)

Weight(IP): 150

Details:

• METHOD: post
• URL: /sapi/v1/simple-earn/locked/setAutoSubscribe

Mandatory params:

• positionId -
• autoSubscribe - true or false

Optional params:

• timestamp - timestamp
• recvWindow - no more than 60000

@spec post_simple_earn_locked_subscribe(any(), any(),
  recvWindow: any(),
  autoSubscribe: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Subscribe Locked Product (TRADE)

Rate Limit: 1/3s per account

You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.

Weight(IP): 1

Details:

• METHOD: post
• URL: /sapi/v1/simple-earn/locked/subscribe

Mandatory params:

• projectId -
• amount -

Optional params:

• timestamp - timestamp
• autoSubscribe - true or false, default true
• recvWindow - no more than 60000