Skip to navigation
API ReferenceAccount

Set auto earn

Enable or disable automatic earning (auto-subscription to earn products) for idle assets of a given currency.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
ccystringRequired
Currency, e.g. BTC.
actionenumRequired
Whether to enable or disable auto earn.
Allowed values:
earnTypeenumOptional

Earn type: 0 simple earn flexible, 1 on-chain earn.

Allowed values:

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional