Change Log

Version 1.0 (8th December 2021)

• Initial release of the earn(invest) api

Version 1.1 (13th December 2021)

• add missing pagination description in request and response from querying investment history
• add processing result to response of deposit/redeem investment

Overview

Generating API Key

You will need to create an API key on the BTSE platform before you can use authenticated APIs. To create API keys, you can follow the steps below:

• Login with your username / email and password into the BTSE website
• Click on “Account” on the top right hand corner
• Select the API tab
• Click on “New API” button to create an API key and passphrase. (Note: the passphrase will only appear once)
• Use your API key and passphrase to construct a signature.

Endpoints

• Production
  • HTTP
    • https://api.btse.com/spot
• Testnet
  • HTTP
    • https://testapi.btse.io/spot

Authentication

• API Key (request-api)

  • Parameter Name: request-api, in: header. API key is obtained from BTSE platform as a string

• API Key (request-nonce)

  • Parameter Name: request-nonce, in: header. Representation of current timestamp in long format

• API Key (request-sign)

  • Parameter Name: request-sign, in: header. A composite signature produced based on the following algorithm: Signature=HMAC.Sha384 (secretkey, (urlpath + request-nonce + bodyStr)) (note: bodyStr = '' when no data):

Investment Endpoints

Query Investment Products

Response

[
  {
    "id": "OPENETH00001",
    "name": "ETH Flex Savings",
    "currency": "ETH",
    "type": "Flex",
    "startDate": 1610685918000,
    "interestStartDate": 1610719200000,
    "rates":
    [
      {
        "days": 1,
        "rate": 1.15
      }
    ],
    "compounding": true,
    "autoRenewSupported": false,
    "dailyLimit": 10.0,
    "minSize": 1.00000000,
    "incrementalSize": 1.00000000
  }
]

GET /api/v3.2/invest/products

Get all investment products

Request Parameters

(None)

Response Content

RateObject

Deposit Investment

Request

{
    "productId": "OPENUSDT0001",
    "amount": 100.99,
    "renew": true,
    "day": 7
}

Reponse

{
    "success": true
}

POST /api/v3.2/invest/deposit

Deposit an investment

Request Parameters

Response Content

Renew Investment

Request

{
    "orderId": 1,
    "autoRenew": false
}

Response

{
    "orderId": 1,
    "autoRenew": false
}

POST /api/v3.2/invest/renew

Renew an investment order

Request Parameters

Response Content

Redeem Investment

Request

{
    "orderId": 1,
    "amount": 12.34
}

Reponse

{
    "success": true
}

POST /api/v3.2/invest/redeem

Redeem an investment order

Request Parameters

Response Content

Query Investment Orders

Response

[
  {
    "id": 456,
    "name": "ETH Flex Savings",
    "currency": "ETH",
    "type": "Flex",
    "rate": 1.15,
    "investAmt": 10.00000000,
    "interestEarned": 0.00031507,
    "nextInterestPayoutTime": 1610632800000,
    "startTime": 0,
    "endTime": 0,
    "duration": 86400000,
    "payoutLockTime": 300000,
    "autoRenew": false,
    "compounding": true,
    "autoRenewSupported": false,
    "dailyLimit": 0,
    "redemptionProcessing": false
  }
]

GET /api/v3.2/invest/orders

Query investment orders

Response Content

Query Investment History

Response

{
  "totalRows": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "data": [
    {
      "txnTime": 1598918400000,
      "name": "USDT Flex Savings",
      "currency": "USDT",
      "rate": 0.5,
      "type": "Flex",
      "txnType": "INVEST_SERVICE_TYPE_DEPOSIT",
      "amount": 100,
      "totalAmount": 2000,
      "interestEarned": 1.22,
      "duration": 0
    }
  ]
}

GET /api/v3.2/invest/history

Query investment history

Request Parameters

Response Content

InvestmentHistoryObject