HomeDocumentationAPI Reference
Log In
API Reference

Get Vault Share

Method Name

public/get_vault_share

Gets the value of a vault's token against the base currency, underlying currency, and USD for a timestamp range.

The name of the vault from the Vault proxy contract is used to fetch the vault's value.

Parameters

from_timestamp_secintegerrequired
From timestamp in seconds
to_timestamp_secintegerrequired
To timestamp in seconds
vault_namestringrequired
Name of the vault
pageinteger
Page number of results to return (default 1, returns last if above num_pages)
page_sizeinteger
Number of results per page (default 100, max 1000)

Response

idstring or integerrequired
resultobjectrequired
result.paginationobjectrequired
Pagination info
result.pagination.countintegerrequired
Total number of items, across all pages
result.pagination.num_pagesintegerrequired
Number of pages
result.vault_sharesarray of objectsrequired
List of vault history shares, recent first
result.vault_shares[].base_valuestringrequired
The value of the vault's token against the base currency. Ex: rswETHC vs rswETH
result.vault_shares[].block_numberintegerrequired
The Derive chain block number
result.vault_shares[].block_timestampintegerrequired
Timestamp of the Derive chain block number
result.vault_shares[].underlying_valuestring or nullrequired
The value of the vault's token against the underlying currency. Ex: rswETHC vs ETH
result.vault_shares[].usd_valuestringrequired
The value of the vault's token against USD

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}