MoxieUserPortfolios

Learn all the detailed references of MoxieUserPortfolios API that provide Farcaster user's Fan Token portfolio on the Moxie protocol, including the input filters and output fields.

The MoxieUserPortfolios API helps you to fetch a Farcaster user's Moxie Fan Token portfolio.

Inputs

filter

Name
Type
Description

fanTokenAddress

String

Filter by Fan Token contract address on Base.

fanTokenSymbol

String

Filter by Fan token symbol. Depending on the Fan Token type, the symbols follow certain formats: - User type: fid:<FID> - Channel type: cid:<CHANNEL-ID> - Network type: network:farcaster

fid

String

Filter by user's FID.

walletAddress

String

Filter by user's wallet address.

blockchain

For MoxieUserPortfolios API, it will return user's Fan Tokens portfolio, whether the Fan Tokens are staked or not, on the Base chain.

You just need to specify the input for the query to work.

Enum
Description

ALL

-

order

Name
Description

totalLockedAmount

Sort by Farcaster profile's farrank.

totalUnlockedAmount

Sort by Farcaster profile's farcaster score.

lockedTvl

Sort by the number of users following the Lens/Farcaster profile on Lens/Farcaster in ascending or descending order.

unlockedTvl

Sort by the number of users being followed by the Lens/Farcaster profile on Lens/Farcaster in ascending or descending order.

tokenLockedTvl

Sort by Lens/Farcaster profile creation block timestamp in ascending or descending order.

tokenUnlockedTvl

Sort by Farcaster profile's social capital rank.

fid

Sort by Farcaster profile's social capital score.

Outputs

Name
Type
Description

fid

String

FID of the holder

beneficiaryVestingAddress

The vesting contract and beneficiary details related to the holder.

totalLockedAmount

Float

total quantity of a particular Fan Token locked in Moxie Power staking contract by the FID.

totalLockedAmountInWei

String

total quantity of a particular Fan Token locked in Moxie Power staking contract by the FID formatted in wei.

totalUnlockedAmount

Float

total quantity of a particular Fan Token that is not staked by the FID.

totalUnlockedAmountInWei

String

total quantity of a particular Fan Token that is not staked by the FID formatted in wei.

lockedTvl

Float

total amount in moxie of a particular Fan Token locked in Moxie Power staking contract by the FID.

lockedTvlInWei

String

total amount in moxie of a particular Fan Token locked in Moxie Power staking contract by the FID formatted in wei.

unlockedTvl

Float

total amount in moxie of a particular Fan Token that is not staked by the FID.

unlockedTvlInWei

String

otal amount in moxie of a particular Fan Token that is not staked by the FID formatted in wei.

fanTokenAddress

String

Fan token contract address.

fanTokenName

String

Fan Token name.

fanTokenSymbol

String

Fan Token symbol.

currentPrice

Float

Current price of Fan Token in terms of Moxie.

currentPriceInWei

String

Current price of Fan Token in terms of Moxie formatted in wei.

protocolTokenInvested

Float

The amount of Moxie that is deposited in to the bonding curve when a buy occured.

protocolTokenInvestedInWei

String

The amount of Moxie that is deposited in to the bonding curve when a buy occured formatted in wei.

tokenLockedTvl

Float

total quantity of a particular Fan Token locked in Moxie Power staking contract in the Moxie protocol.

tokenLockedTvlInWei

String

total quantity of a particular Fan Token locked in Moxie Power staking contract in the Moxie protocol formatted in wei.

tokenUnlockedTvl

Float

total quantity of a particular Fan Token that is not staked in the Moxie protocol.

tokenUnlockedTvlInWei

String

quantity of a particular Fan Token that is not staked in the Moxie protocol formatted in wei.

walletAddress

[String]

List of all wallet address.

walletFanTokens

List of holding of this Fan Token across different wallet address for by this FID.

holderSocial

Nested Query – Social details for the FID who requesting portfolio details.

fanTokenSocial

Nested Query – Social details Fan token owner if it is a user Fan Token.

fanTokenChannel

Nested Query – Social details Fan token owner if it is a channel Fan Token.

Last updated