AppController_getAccounts

GET 
/api/v1/accounts

AppController_getAccounts

Request

Query Parameters

order string

Possible values: [ASC, DESC]

Default value: ASC

Sort order

offset number

How many results to skip (for pagination)

limit number

Maximum number of results

sort string

Possible values: [balance]

Field on which the sort is applied

public_key string

Public key of the account

id string

Account ID

balance_gte number

Minimum balance in CMTS (inclusive)

balance_lte number

Maximum balance in CMTS (inclusive)

with_escrow boolean

Filter accounts with at least one escrow lock

with_vesting boolean

Filter accounts with at least one vesting lock

with_staking boolean

Filter accounts with at least one staking lock

Responses

200

application/json

Schema

Schema

hasMore booleanrequired

Set to 'true' if more results are available.

totalRecords number

Total number of available records. Returned only when 'offset' is used in the query.

items

object[]

required

Array [

id stringrequired

publicKey stringrequired

height numberrequired

balance numberrequired

spendable numberrequired

lockedInStaking numberrequired

lockedInVesting numberrequired

lockedInEscrows numberrequired

stakingLocks

object[]

required

Array [

amount numberrequired

validatorNodeId stringrequired

plannedUnlockAmountInAtomics numberrequired

plannedUnlockTimestamp numberrequired

slashed booleanrequired

plannedSlashingAmountInAtomics numberrequired

plannedSlashingTimestamp numberrequired

]

vestingLocks

object[]

required

Array [

amount numberrequired

initialVestedAmountInAtomics numberrequired

cliffStartTimestamp numberrequired

cliffDurationDays numberrequired

vestingDurationDays numberrequired

]

escrowLocks

object[]

required

Array [

amount numberrequired

escrowIdentifier stringrequired

fundEmitterAccountId stringrequired

transferAuthorizerAccountId stringrequired

startTimestamp numberrequired

durationDays numberrequired

]

]

Example (from schema)

{
  "hasMore": true,
  "totalRecords": 0,
  "items": [
    {
      "id": "string",
      "publicKey": "string",
      "height": 0,
      "balance": 0,
      "spendable": 0,
      "lockedInStaking": 0,
      "lockedInVesting": 0,
      "lockedInEscrows": 0,
      "stakingLocks": [
        {
          "amount": 0,
          "validatorNodeId": "string",
          "plannedUnlockAmountInAtomics": 0,
          "plannedUnlockTimestamp": 0,
          "slashed": true,
          "plannedSlashingAmountInAtomics": 0,
          "plannedSlashingTimestamp": 0
        }
      ],
      "vestingLocks": [
        {
          "amount": 0,
          "initialVestedAmountInAtomics": 0,
          "cliffStartTimestamp": 0,
          "cliffDurationDays": 0,
          "vestingDurationDays": 0
        }
      ],
      "escrowLocks": [
        {
          "amount": 0,
          "escrowIdentifier": "string",
          "fundEmitterAccountId": "string",
          "transferAuthorizerAccountId": "string",
          "startTimestamp": 0,
          "durationDays": 0
        }
      ]
    }
  ]
}

Loading...