rewards_api

Module Group: Accounts
Parsing Order: 360
Database Size: 29.620 GB

The rewards_api provides access to author, curation, beneficiary, and producer reward information, including both historical and upcoming rewards.


Configuration

{
   "db_path": "~/sds_data1",
   "id": "rewards_api",
   "group_id": "accounts",
   "parsing_order": 360,
   "required_modules": ["chain_api"],
   "referenced_modules": ["steem_requests_api", "posts_api", "feeds_api"],
   "parse_reversible": true,
   "parsed_virtual_ops": [
      "author_reward",
      "comment_benefactor_reward",
      "curation_reward",
      "liquidity_reward",
      "producer_reward",
      "interest",
      "proposal_pay"
   ]
}

Endpoints

getConfig

Returns this module's active configuration.

Endpoint

/rewards_api/getConfig

Historic Rewards

getRewards

Returns individual reward transactions for an account by operation type and time range.

Endpoint

/rewards_api/getRewards/:op/:account/:fromTime-:toTime/:limit?/:offset?

Example

/rewards_api/getRewards/curation_reward/steemchiller/1767000000-1767640000/10

Parameters

Name Type Optional Allowed Values
:op string No author_reward, curation_reward, comment_benefactor_reward, producer_reward, interest
:account string No Account name
:fromTime int No Start time (Unix)
:toTime int No End time (Unix)
:limit int Yes Max results
:offset int Yes Offset

Example Response:

{
   "code": 0,
   "result": {
      "cols": {"time": 0, "vests": 1, "author": 2, "permlink": 3},
      "rows": [
         [1767007155, 29319.617835, "ecoburn", "ecoburn-post-244"],
         [1767017016, 19701.450771, "thaizmaita", "daily-menu-delicacies-..."],
         [1767020211, 21055.406941, "misslaila", "forgetting-trauma-and-sadness..."],
         [1767027492, 26722.996719, "ikwal", "poesia-estoy-seguro-que-puedo"],
         [1767029358, 27580.103578, "eka99", "beautiful-memories-are-now-..."],
         [1767054342, 30708.633762, "adeljose", "steem-alliance-detective-report-..."],
         [1767067872, 25764.626466, "kiwiscanfly", "sorting-stuff-out"]
      ]
   }
}

Recent @steemchiller Curation Rewards:

Author Post VESTS Earned
adeljose Steem Alliance Report 30,708
ecoburn Ecoburn Post 244 29,319
eka99 Beautiful memories... 27,580
ikwal Poesia 26,722

getRewardsSums

Returns summed rewards for an account by operation type.

Endpoint

/rewards_api/getRewardsSums/:op/:account/:fromTime-:toTime

Example

/rewards_api/getRewardsSums/curation_reward/steemchiller/1767000000-1767640000

Example Response:

{
   "code": 0,
   "result": {
      "vests": 1902276.414223
   }
}

@steemchiller earned 1,902,276 VESTS (~1,157 SP) in curation rewards during this period.


getAllRewardsSums

Returns all reward type sums for an account.

Endpoint

/rewards_api/getAllRewardsSums/:account/:fromTime-:toTime

Example

/rewards_api/getAllRewardsSums/steemchiller/1767000000-1767640000

Example Response:

{
   "code": 0,
   "result": {
      "author_reward": {"sbd": 0, "steem": 0, "vests": 0},
      "comment_benefactor_reward": {"sbd": 0, "steem": 0, "vests": 0},
      "curation_reward": {"vests": 1902276.414223},
      "liquidity_reward": {"steem": 0},
      "producer_reward": {"vests": 4536116.139371},
      "interest": {"sbd": 0},
      "proposal_pay": {"sbd": 0}
   }
}

@steemchiller's Reward Summary (7-day period):

Reward Type Amount
Producer Rewards 4,536,116 VESTS (~2,760 SP)
Curation Rewards 1,902,276 VESTS (~1,157 SP)
Author Rewards 0
Beneficiary Rewards 0
Total ~3,917 SP

Coming Rewards

These endpoints show pending rewards for posts still in the 7-day payout window.

getComingAuthorRewardsSummary

Returns upcoming author rewards summary.

Endpoint

/rewards_api/getComingAuthorRewardsSummary/:account

Example

/rewards_api/getComingAuthorRewardsSummary/steemchiller

getComingBeneficiaryRewardsSummary

Returns upcoming beneficiary rewards summary.

Endpoint

/rewards_api/getComingBeneficiaryRewardsSummary/:account

getComingCurationRewardsSummary

Returns detailed upcoming curation rewards with vote data.

Endpoint

/rewards_api/getComingCurationRewardsSummary/:account

Example

/rewards_api/getComingCurationRewardsSummary/steemchiller

Example Response (truncated):

{
   "code": 0,
   "result": {
      "posts": {
         "cols": {
            "author": 0, "permlink": 1, "created": 2, "cashout_time": 3,
            "rewards": 4, "pending_payout": 5, "vote_count": 6, "is_comment": 7,
            "is_payout_dust": 8, "is_payout_declined": 9, "is_curation_allowed": 10,
            "beneficiaries": 11, "vote": 12
         },
         "rows": [
            ["misslaila", "it-s-very-difficult-to-explain...", 1767036327, 1767641127,
               {...rewards data...}, 8.002, 2, 0, 0, 0, 1, [["realrobinhood", 2500]],
               {"time": 1767044175, "percent": 10000, "rshares": 25428499549884,
                "rewards": {"curator": {"sp": 17.711, "vests": 29115.338525, "efficiency": 53.966}},
                "stu": 4.419}
            ]
         ]
      },
      "sum_sp": 1137.075,
      "sum_vests": 1869252.078,
      "sum_efficiency": 3492.801,
      "sum_weighted_eff": 3391.753,
      "count": 71,
      "count_weighted_eff": 69
   }
}

@steemchiller's Pending Curation Rewards:

Metric Value
Posts voted 71
Total pending SP 1,137.075 SP
Total pending VESTS 1,869,252 VESTS
Average efficiency 49.2%

Back to Main Index