Get Portfolio Address History

Use this endpoint to retrieve the daily balance history for a registered portfolio address over a specific time period.

You need to first register a portfolio address with Register Portfolio Address

Only BTC balances are supported at the moment. More Bitcoin asset balances will follow soon.

get

Get the daily balance history for an address from the portfolio.

Authorizations

x-api-keystringRequired

Query parameters

addressstringRequired

offsetnumberOptionalDefault: 0

limitnumber · min: 25 · max: 25OptionalDefault: 25

startDatestringRequired

from date, inclusive - (e.g. 2024-08-29)

endDatestringRequired

to date, exclusive - (e.g. 2024-09-01)

assetTypestring · enumOptionalPossible values:

Responses

200

Default Response

application/json

limitnumberRequired

offsetnumberRequired

lastBlockHeightnumber · nullableRequired

400

Invalid input

application/json

401

Unauthorized

application/json

404

Not found

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get/v1/portfolio/history

GET /v1/portfolio/history?address=text&startDate=text&endDate=text HTTP/1.1
Host: api.secretkeylabs.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "limit": 1,
  "offset": 1,
  "lastBlockHeight": 1,
  "items": [
    {
      "assetType": "text",
      "assetId": "text",
      "address": "text",
      "balance": {
        "valueInSats": "text",
        "valueInUsd": "text"
      },
      "date": "text"
    }
  ]
}