models.md

Return Types

Action

Name	Type	Optional

AddressActivity

Name	Type	Optional
address	str
active	bool

AddressArbitrumAsset

Name	Type	Optional
asset	L2Asset
quantity	str

AddressAsset

Name	Type	Optional
asset	Asset
quantity	str

AddressBSCAsset

Name	Type	Optional
asset	L2Asset
quantity	str

AddressBoost

Name	Type	Optional
address	str
fee	float
boost_status	BoostStatus	yes
boost_expiration	datetime	yes
tokens	BoostToken	yes

AddressInfo

Name	Type	Optional
address	str
type	str
proxies	str	yes
cdps	int	yes
vaults	int	yes
aggregated_at	int	yes

AddressL2Asset

Name	Type	Optional
asset	L2Asset
quantity	str

AddressNFT

Name	Type	Optional
id	str
asset	NFTAsset
amount	str
section	str
section_tokens_count	int
standard	str
displayed_on_chart	bool
value	float	yes

AddressOptimismAsset

Name	Type	Optional
asset	L2Asset
quantity	str

AddressPolygonAsset

Name	Type	Optional
asset	L2Asset
quantity	str

AddressPositions

Name	Type	Optional
positions	Position	yes
aggregation_in_progress	bool

Asset

Name	Type	Optional
id	str
asset_code	str
name	str
symbol	str
decimals	int
implementations	ChainId	yes
type	AssetTypeOld	yes
icon_url	str	yes
price	Price	yes
is_displayable	bool
is_verified	bool

AssetAction

Name	Type	Optional
id	str
transaction_hash	str
type	AssetActionType
value	float	yes
quantity	str
price	float	yes
datetime	int
asset	Asset
status	TransactionStatus
direction	Direction
fee	AssetActionFee	yes

AssetActionAmount

Name	Type	Optional
base	float
currency	float	yes

AssetActionFee

Name	Type	Optional
quantity	str
value	float

AssetComponent

Name	Type	Optional
asset	Asset
quantity	float
share	float
allocation	float

AssetDescription

Name	Type	Optional
asset_code	str
full	str	yes

AssetFullInfo

Name	Type	Optional
asset	Asset
title	str
stats	AssetFullInfoStats
components	str	yes
gradient_color	str	yes
explore_sections	int	yes
subtitle	str	yes
tagline	str	yes
market_cap	float	yes
fully_diluted_valuation	float	yes
total_supply	float	yes
circulating_supply	float	yes
relative_changes	str	yes
description	str	yes
relevant_resources	AssetRelevantResource	yes
tags	str	yes
is_tradable	bool

AssetFullInfoStats

Name	Type	Optional
asset_code	str
year_min	float	yes
year_max	float	yes
volume_24h	float	yes

AssetImplementation

Name	Type	Optional
address	str	yes
decimals	int

AssetInfo

Name	Type	Optional
asset	Asset
title	str
gradient_color	str	yes
explore_sections	int	yes
subtitle	str	yes
tagline	str	yes
market_cap	float	yes
total_supply	float	yes
circulating_supply	float	yes
relative_changes	str	yes
tags	str	yes

AssetRelevantResource

Name	Type	Optional
name	str
url	str
displayable_name	str	yes

AssetStats

Name	Type	Optional
total_returned	float	yes
total_returned_net	float	yes
total_returned_change	float	yes
total_fee_spent	float	yes
avg_buy_price	float	yes
avg_buy_price_net	float	yes
avg_sell_price	float	yes
avg_sell_price_net	float	yes

AssetTag

Name	Type	Optional
id	str

BlockLag

Name	Type	Optional
block_lag	int	yes

BoostToken

Name	Type	Optional
name	str
amount	str
boost_status	BoostStatus	yes
boost_expiration	datetime	yes
asset_code	str

Category

Name	Type	Optional
id	str
title	str
tagline	str
order_by	str	yes
display_type	CategoryDisplayType

ChainGasPriceInfo

Name	Type	Optional
source	str	yes
datetime	datetime
info	str	yes

ChainInfo

Name	Type	Optional
id	str
chain	str
evm_id	int	yes
external_id	str	yes
name	str
node_urls	str	yes
icon_url	str
base_asset_id	str
block_explorer_urls	str	yes
explorer_token_url	str	yes
explorer_tx_url	str	yes
explorer_home_url	str	yes
explorer_name	str	yes
rpc_url_internal	str	yes

ChainInfoAsset

Name	Type	Optional
id	str
address	str
name	str
symbol	str
decimals	int

ClassicGasPriceInfo

Name	Type	Optional
slow	int	yes
standard	int	yes
fast	int	yes
rapid	int	yes

CompoundAction

Name	Type	Optional
id	str
type	TransactionAction
transaction_hash	str
status	TransactionStatus
ctoken	str	yes
ctoken_value	float	yes
underlying_value	float	yes
datetime	datetime

CompoundAsset

Name	Type	Optional
underlying	Asset
underlying_eth_price	float
asset	Asset
borrow_rate	float	yes
supply_rate	float	yes
exchange_rate	float	yes

CompoundDeposit

Name	Type	Optional
asset	CompoundAsset
deposited	float
earned_interest	float
ctokens	int

CompoundInfo

Name	Type	Optional
loans	CompoundLoan	yes
deposits	CompoundDeposit	yes
total_debt	float
total_collateral	float

CompoundLoan

Name	Type	Optional
asset	CompoundAsset
borrowed	float
accrued_interest	float

Deposit

Name	Type	Optional
id	str
asset	Asset
deposited	float
value	float
supply_rate	float	yes
section	str
protocol	str
displayed_on_chart	bool

DyDxAccountBalance

Name	Type	Optional
owner	str
account_number	str
normalized_balance	float
balance	float
asset	Asset

EIP1559GasPriceInfo

Name	Type	Optional
base_fee	int	yes
slow	GasFeeInfo
standard	GasFeeInfo
fast	GasFeeInfo
rapid	GasFeeInfo

EmptyObject

Name	Type	Optional

ExploreSection

Name	Type	Optional
id	int
title	str
tagline	str
order	int
alias	str	yes

ExternalTransaction

Name	Type	Optional
id	str
type	ExternalTransactionType
chain	str
hash	str
mined_at_block	int
mined_at	datetime
sent_from	str
sent_to	str
status	ExternalTransactionStatus
nonce	int
fee	ExternalFee
transfers	ExternalTransfer	yes
approvals	ExternalApproval	yes

FullTotalValue

Name	Type	Optional
last_price	float
floor_price	float

GasFeeInfo

Name	Type	Optional
priority_fee	int
max_fee	int
estimation_seconds	int	yes

GasPriceInfo

Name	Type	Optional
rapid	int	yes
fast	int	yes
standard	int	yes
slow	int	yes
source	str
datetime	datetime

L2Asset

Name	Type	Optional
asset_code	str
name	str
symbol	str
decimals	int
icon_url	str	yes
value	float	yes

LiquityTroveAction

Name	Type	Optional
id	str
trove	int
type	str
transaction_hash	str
debt_change	float	yes
collateral_change	float	yes
datetime	datetime

Loan

Name	Type	Optional
id	str
asset	Asset
borrowed	float
value	float
borrow_rate	float	yes
section	str
protocol	str
displayed_on_chart	bool

LockedAsset

Name	Type	Optional
id	str
asset	Asset
locked	float
value	float
section	str
protocol	str
displayed_on_chart	bool

MakerCDP

Name	Type	Optional
id	int
owner	str
debt	float
collateral	float

MakerCDPAction

Name	Type	Optional
type	str
transaction	str
timestamp	int
dai_value	float	yes
eth_value	float	yes
peth_value	float	yes
owner	str	yes
new_owner	str	yes

MakerVault

Name	Type	Optional
id	int
owner	str
normalized_debt	float
outstanding_debt	float
total_borrowed	float
total_repaid	float
accrued_interest	float
collateral	float
collateral_type	str

MakerVaultAction

Name	Type	Optional
id	str
vault	int
type	MakerDSSActionType
transaction_hash	str
normalized_debt_change	float	yes
debt_change	float	yes
collateral_change	float	yes
owner	str	yes
new_owner	str	yes
datetime	datetime

NFTAsset

Name	Type	Optional
asset_code	str
symbol	str
contract_address	str
token_id	str
interface	str
preview	NFTContent
detail	NFTContent
name	str	yes
type	AssetTypeOld	yes
tags	str	yes
last_price	float	yes
buy_now_price	float	yes
floor_price	float	yes
total_last_price	float	yes
total_floor_price	float	yes
is_displayable	bool
is_verified	bool
collection	NFTCollection	yes
collection_info	NFTOpenseaCollection	yes
changed_at	int	yes

NFTAttribute

Name	Type	Optional
key	str
value	str

NFTCollection

Name	Type	Optional
name	str
description	str	yes
icon_url	str	yes

NFTCollectionInfo

Name	Type	Optional
collection_id	str
name	str
icon_url	str	yes
description	str	yes
floor_price	float	yes
nfts_count	int	yes
num_owners	int	yes
one_day_volume	float	yes
seven_day_volume	float	yes
thirty_day_volume	float	yes
one_day_change	float	yes
total_volume	float	yes
market_cap	float	yes
banner_image_url	str	yes
relevant_urls	NFTCollectionRelevantURL	yes
created_date	str	yes

NFTCollectionRelevantURL

Name	Type	Optional
name	str
url	str

NFTContent

Name	Type	Optional
url	str	yes
meta	dict	yes

NFTInfo

Name	Type	Optional
asset	NFTAsset
collection	NFTCollection
collection_info	NFTOpenseaCollection	yes
description	str	yes
attributes	NFTAttribute	yes
relevant_urls	NFTRelevantURL	yes

NFTOpenseaCollection

Name	Type	Optional
slug	str
name	str	yes
description	str	yes
icon_url	str	yes

NFTRelevantURL

Name	Type	Optional
name	str
url	str

OptimisticGasPriceInfo

Name	Type	Optional
l1	int	yes
l2	int	yes
fixed_overhead	int	yes
dynamic_overhead	int	yes

Portfolio

Name	Type	Optional
assets_value	float
deposited_value	float
borrowed_value	float
locked_value	float
staked_value	float
arbitrum_assets_value	float
aurora_assets_value	float
avalanche_assets_value	float
bsc_assets_value	float
ethereum_assets_value	float
fantom_assets_value	float
loopring_assets_value	float
optimism_assets_value	float
polygon_assets_value	float
solana_assets_value	float
xdai_assets_value	float
nft_last_price_value	float
nft_floor_price_value	float
total_value	float
absolute_change_24h	float
relative_change_24h	float	yes

PortfolioChange

Name	Type	Optional
absolute	float
relative	float	yes

PortfolioDecomposition

Name	Type	Optional
positions_types_distribution	str	yes
positions_chains_distribution	str	yes
nfts	str	yes
change_24h	PortfolioChange
total_value	float

Position

Name	Type	Optional
id	str
asset	Asset
quantity	str
value	float
chain	ChainId
type	str
protocol	TransactionProtocolOld	yes
name	str
parent_id	str	yes
included_in_chart	bool
is_displayable	bool
apy	float	yes
updated_at	datetime	yes
updated_at_block	int	yes

PositionDetail

Name	Type	Optional
asset_code	str
amount	int
tokens_owed	int
fee_growth	int

Price

Name	Type	Optional
value	float
relative_change_24h	float	yes
changed_at	int

PriceStat

Name	Type	Optional
min	float
max	float
relative_change	float

StakedAsset

Name	Type	Optional
id	str
asset	Asset
staked	float
value	float
section	str
protocol	str
displayed_on_chart	bool

Tokenlist

Name	Type	Optional
id	str
name	str
icon_url	str
total_tokens	int
has_asset_code	bool

Transaction

Name	Type	Optional
id	str
type	RDBTransactionType
protocol	str
mined_at	int
block_number	int
status	TransactionStatus
hash	str
direction	Direction	yes
address_from	str	yes
address_to	str	yes
contract	str	yes
nonce	int	yes
changes	TransactionChange	yes
fee	TransactionFee	yes
meta	str	yes

TransactionChange

Name	Type	Optional
asset	Asset
value	int
direction	Direction
address_from	str
address_to	str
price	float	yes

TransactionFee

Name	Type	Optional
value	int
price	float