Retrieve Moxie earning status

farcasterMoxie.getEarningStat

Overview

Retrieve Moxie earning status for a certain user, channel or entire network.

Parameters

name	type	required	Note
entity_type	string	true	"USER", "CHNNEL" or "NETWORK"
entity_id	string	false	If entity_type is "USER" : "721870". If entity_type is "CHANNEL": "base". If entity_type is "NETWORK": null
timeframe	string	false	"LIFETIME", "TODAY" or "WEEKLY"

Usage

Typescript

let res = await Lum0x.farcasterMoxie.getEarningStat({
    entity_type: "USER",
    entity_id: "721870",
    timeframe: "LIFETIME"
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "data": {
    "FarcasterMoxieEarningStats": {
      "FarcasterMoxieEarningStat": [
        {
          "allEarningsAmount": 56.17236528230401,
          "allEarningsAmountInWei": "56172365282304010000",
          "castEarningsAmount": 56.17236528230401,
          "castEarningsAmountInWei": "56172365282304010000",
          "entityId": "721870",
          "entityType": "USER",
          "frameDevEarningsAmount": 0,
          "frameDevEarningsAmountInWei": "0",
          "otherEarningsAmount": 0,
          "otherEarningsAmountInWei": "0",
          "timeframe": "LIFETIME"
        }
      ]
    }
  }
}

Key	Value
allEarningsAmount	56.17236528230401
allEarningsAmountInWei	56172365282304010000
castEarningsAmount	56.17236528230401
castEarningsAmountInWei	56172365282304010000
entityId	721870
entityType	USER
frameDevEarningsAmount	0
frameDevEarningsAmountInWei	0
otherEarningsAmount	0
otherEarningsAmountInWei	0
timeframe	LIFETIME

Field Description

• allEarningsAmount: The total earnings amount paid to the user (in Ether).

• allEarningsAmountInWei: The total earnings amount expressed in Wei.

• castEarningsAmount: The earnings amount from content creation paid to the user (in Ether).

• castEarningsAmountInWei: The content creation earnings amount expressed in Wei.

• entityId: The unique ID of the user or entity.

• entityType: The type of entity providing the earnings information (e.g., USER).

• frameDevEarningsAmount: The earnings amount related to frame development (in Ether).

• frameDevEarningsAmountInWei: The frame development earnings amount expressed in Wei.

• otherEarningsAmount: Other earnings amount (in Ether).

• otherEarningsAmountInWei: The other earnings amount expressed in Wei.

• timeframe: The period for which the earnings information is provided (e.g., LIFETIME).