API
The Venus Protocol API providing access to indexed protocol data.
Last updated
The Venus Protocol API providing access to indexed protocol data.
Last updated
Venus Protocol API provides two groups of endpoints
Market Data - Endpoints relating to lending markets
Activity - Endpoints relating to user interactions with markets
Governance - Endpoints providing information about proposals and voter activity
The API is available without authentication for testnet and mainnet.
mainnet: testnet:
Endpoints are versioned using the accept-version
header. The values for this header can be stable
or next
. By default the stable
version is returned. When a next
version is available, a Warning - 299
header will be added to the stable
version with a message of breaking changes. To receive this new version the accept-version
header can be set to next
.
When the latest next
version is made stable and the previous stable version is deprecated, both values for accept-version
will return the latest version. Using the next
header at this point will add a Warning - 299
header alerting the client to remove accept-version: next
to avoid receiving unexpected changes in the future.
These steps describe the process of upgrading endpoints to new versions as they are released
A next
version is made available, accessible with the accept-version: next
header. A Warning - 299
header is added to the stable version with details about breaking changes.
Clients will be given adequate time to upgrade to use the next version.
The previous stable version will be deprecated, the next version becomes stable and using the accept-version: next
header will add a warning to remove the header or use the stable version.
Clients remove the accept-version: next
header to avoid receiving unexpected changes.
The endpoint is now ready to release another version.
Returns pool data for all listed pools, optionally filterable by the pool's comptroller address.
Blockchain Id used to filter results to a specific chain
Pool address
Filter by pool name
Price Oracle address
Array of columns to order results. Default sort is descending. If '+' is prepended to a column it will be sorted ascending.
Limit used for pagination
20
Page number to fetch
0
Returns market data for listed markets, optionally filterable by asset address, name, symbol, underlying address, underlying name or underlying symbol.
Blockchain Id used to filter results to a specific chain
Filter by vToken address
Filter by asset symbol
Filter by asset name
Filter by underlying address
Filter by underlying name
Filter by underlying symbol
Array of columns to order results. Default sort is descending. If '+' is prepended to a column it will be sorted ascending.
Limit used for pagination
20
Page number to fetch
0
Fetch an array of daily snapshots of supply and borrow totals and supply and borrow apy over the previous 365 days for a given asset.
Blockchain Id used to filter results to a specific chain
Filter by vToken address
year
Available options: Get vote summary for a given proposal, includes sums of for, against, abstain and total votes.
Proposal Id for fetching a detailed proposal
Retrieve a summary of an account's voter profile.
Account address
Retrieve the history of proposals a given account has voted on
Account address
Query voter accounts ordered by votes.
Limit used for pagination
20
Page number to fetch
0
Returns paginated array of proposals.
Filter by proposal ID
Filter by proposal state
Array of columns to order results. Default sort is descending. If '+' is prepended to a column it will be sorted ascending.
Limit used for pagination
20
Page number to fetch
0
Get voter details for a given proposal.
Filter by proposal ID
Account address
Array of columns to order results. Default sort is descending. If '+' is prepended to a column it will be sorted ascending.
Limit used for pagination
20
Page number to fetch
0
Returns paginated array of proposals. It takes an optional array of proposal ids to filter by.
Proposal Id for fetching a detailed proposal