accounts_api

Module Group: Accounts
Parsing Order: 190
Database Size: 6.501 GB

The accounts_api provides comprehensive access to account information, metadata, and account-related operations.

Configuration

{
   "id": "accounts_api",
   "group_id": "accounts",
   "parsing_order": 190,
   "required_modules": ["chain_api"],
   "optional_modules": ["followers_api"],
   "referenced_modules": ["post_votes_api"],
   "data_source_contents": ["accounts"],
   "parse_reversible": true,
   "parsed_ops": true,
   "parsed_virtual_ops": true,
   "available_events": ["onSyncAccount"],
   "event_handlers": [
      "chain_api.onCreateAccount",
      "chain_api.onCreatePost",
      "chain_api.onUpdatePost",
      "post_votes_api.onAddVote",
      "post_votes_api.onUpdateVote",
      "post_votes_api.onRemoveVote",
      "followers_api.onFollowAccount",
      "followers_api.onUnfollowAccount"
   ]
}

Endpoints

getConfig

Returns this module's active configuration.

Endpoint

/accounts_api/getConfig

Account Data By Name

getAccount

Returns detailed information for a single account.

Endpoint

/accounts_api/getAccount/:account/:fields?

Example

/accounts_api/getAccount/steemchiller

Example Response (truncated):

{
   "code": 0,
   "result": {
      "name": "steemchiller",
      "owner": {"weight_threshold": 1, "key_auths": [["STM5sSD...", 1]]},
      "active": {"weight_threshold": 1, "key_auths": [["STM5zRF...", 1]]},
      "posting": {"weight_threshold": 1, "key_auths": [["STM7pyV...", 1]]},
      "memo_key": "STM7fpwXqFXPwafv7gZMifgiEGtNQ1T2jf5Jad4pSZYt1DDBfJjMU",
      "json_metadata": "{\"profile\":{\"about\":\"Steem Dev...\",\"website\":\"https://steemworld.org\"}}",
      "created": 1495039704,
      "recovery_account": "steemworld.org",
      "voting_power": 9093,
      "balance": 0,
      "sbd_balance": 0.022,
      "vesting_shares": 1003865241.946153,
      "delegated_vesting_shares": 215142.223339,
      "received_vesting_shares": 357736916.725882,
      "curation_rewards": 155102074,
      "posting_rewards": 18766821,
      "pending_claimed_accounts": 36183,
      "reputation": "294867547732686",
      "voting_csi": 6.8,
      "selfvote_rate": 0,
      "witness_votes": ["justyy", "jswit", "steemchiller", ...]
   }
}

getAccounts

Returns information for multiple accounts.

Endpoint

/accounts_api/getAccounts/:accounts/:fields?

Example

/accounts_api/getAccounts/steemchiller,blocktrades

Result: JSON Array of account objects

getAccountExt

Returns extended account information with additional computed fields.

Endpoint

/accounts_api/getAccountExt/:account/:observer?/:fields?

Example

/accounts_api/getAccountExt/steemchiller

Example Response (truncated):

{
   "code": 0,
   "result": {
      "id": 162940,
      "name": "steemchiller",
      "creator": "steem",
      "recovery_account": "steemworld.org",
      "created": 1495039704,
      "last_action": 1767608655,
      "last_sync": 1767630180,
      "reputation": 74.226,
      "voting_csi": 6.8,
      "selfvote_rate": 0,
      "curation_rewards": 155102074,
      "posting_rewards": 18766821,
      "count_comments": 3867,
      "count_root_posts": 181,
      "count_active_posts": 0,
      "count_replies": 9794,
      "count_upvotes": 39153,
      "count_upvoted": 120843,
      "count_downvotes": 2457,
      "count_downvoted": 377,
      "count_followers": 6432,
      "count_following": 295,
      "balance_steem": 0,
      "balance_sbd": 0.022,
      "vests_own": 1003865241.946153,
      "vests_in": 357736916.725882,
      "vests_out": 215142.223339,
      "powerdown": 32895036.194815,
      "powerdown_rate": 8223759.048704,
      "upvote_mana_percent": 95.92,
      "downvote_mana_percent": 100,
      "rc_mana_percent": 73.7
   }
}

Extended Fields:

Field Description
count_followers Number of followers
count_following Number of accounts followed
count_upvotes Total upvotes given
count_upvoted Total upvotes received
upvote_mana_percent Current voting mana percentage
rc_mana_percent Current resource credits percentage

getAccountsExt

Returns extended information for multiple accounts.

Endpoint

/accounts_api/getAccountsExt/:accounts/:observer?/:fields?

getVestingWithdrawRoutes

Returns vesting withdraw routes for an account.

Endpoint

/accounts_api/getVestingWithdrawRoutes/:account

Example

/accounts_api/getVestingWithdrawRoutes/steemchiller

Example Response:

{
   "code": 0,
   "result": {
      "cols": {"from": 0, "to": 1, "percent": 2, "auto_vest": 3},
      "rows": [
         ["steemchiller", "realrobinhood", 6500, 0]
      ]
   }
}

This shows steemchiller has 65% of powerdowns going to @realrobinhood.

Account Data By ID

getAccountById

Returns account data by internal ID.

Endpoint

/accounts_api/getAccountById/:accountId/:fields?

Example

/accounts_api/getAccountById/29

Example Response (truncated):

{
   "code": 0,
   "result": {
      "name": "steemit",
      "created": 1458838821,
      "mined": 1,
      "balance": 398418.151,
      "sbd_balance": 153099.071,
      "vesting_shares": 5640467.421072,
      "reputation": "12944616889",
      "pending_claimed_accounts": 0
   }
}

Account ID 29 is the @steemit account (the original Steemit Inc account).

getAccountsById

Returns multiple accounts by IDs.

Endpoint

/accounts_api/getAccountsById/:accountIds/:fields?

getAccountExtById

Returns extended account by ID with observer.

Endpoint

/accounts_api/getAccountExtById/:accountId/:observer?/:fields?

getAccountsExtById

Returns extended accounts by IDs.

Endpoint

/accounts_api/getAccountsExtById/:accountIds/:observer?/:fields?

getVestingWithdrawRoutesById

Returns vesting withdraw routes by account ID.

Endpoint

/accounts_api/getVestingWithdrawRoutesById/:accountId

List Accounts

getAccountsByPrefix

Returns accounts matching a name prefix.

Endpoint

/accounts_api/getAccountsByPrefix/:prefix/:observer?/:fields?/:limit?/:offset?

Example

/accounts_api/getAccountsByPrefix/steem/steemchiller/name,reputation/10

Example Response:

{
   "code": 0,
   "result": {
      "cols": {"name": 0, "reputation": 1},
      "rows": [
         ["steem", 25],
         ["steem--cn", 25],
         ["steem-01", 38.713],
         ["steem-1", 44.103],
         ["steem-111", 25],
         ["steem-123", 25],
         ["steem-1up", 62.248],
         ["steem-2018", 25],
         ["steem-22-sarx", 25],
         ["steem-39", 25]
      ]
   }
}

getAccountsSortedBy

Returns accounts sorted by a specific field.

Endpoint

/accounts_api/getAccountsSortedBy/:sortField/:sortDir/:observer?/:fields?/:limit?/:offset?

Parameters

Name Type Optional Allowed Values
:sortField string No reputation, vesting_shares, created, balance, etc.
:sortDir string No asc, desc

Statistics

getAccountCountByVESTSRange

Returns the count of accounts within a VESTS range.

Endpoint

/accounts_api/getAccountCountByVESTSRange/:type/:fromVESTS-:toVESTS

Example

/accounts_api/getAccountCountByVESTSRange/own/1000000000-10000000000000

Example Response:

{
   "code": 0,
   "result": 36
}

This shows there are 36 whale accounts with 1B+ VESTS.

getVestingStats

Returns overall vesting statistics broken down by account tiers.

Endpoint

/accounts_api/getVestingStats

Example Response:

{
   "code": 0,
   "result": {
      "defs": {
         "redfish": {"from": 0, "to": 999999.999999, "count": 1940830},
         "minnow": {"from": 1000000, "to": 9999999.999999, "count": 5033},
         "dolphin": {"from": 10000000, "to": 99999999.999999, "count": 1156},
         "orca": {"from": 100000000, "to": 999999999.999999, "count": 268},
         "whale": {"from": 1000000000, "count": 36}
      },
      "summary": "redfish (    0 MV -    1 MV ) : 1940830\nminnow  (    1 MV -   10 MV ) :    5033\ndolphin (   10 MV -  100 MV ) :    1156\norca    (  100 MV - 1000 MV ) :     268\nwhale   ( 1000 MV +         ) :      36"
   }
}

Account Tiers by VESTS:

Tier VESTS Range Count
Redfish 0 - 1 MV 1,940,830
Minnow 1 - 10 MV 5,033
Dolphin 10 - 100 MV 1,156
Orca 100 - 1000 MV 268
Whale 1000+ MV 36

Other

getAccountsForSync

Returns accounts for synchronization based on query.

Endpoint

/accounts_api/getAccountsForSync/:query

Back to Main Index