API
Last updated
Last updated
Several data endpoints are used internally and by our partners. These have been created incrementally on an as-needed basis and are not intended for widespread use. This documentation has been added for convenience, but please do not rely on this API for mission-critical data. If you need additional data to use in your application, please reach out on Discord.
Our wrapper API can be found on the api.originprotocol.com
endpoint. Most of the endpoints are wrapping access to our indexer origin-squid
. Note that our graphQl api is not public, you should rely on the REST wrapper api for stability.
Some dates are displayed as timestamps or epochs, which can be converted to human-readable dates here.
GET
https://api.originprotocol.com/api/v2/{token}/apr/trailing/{days}{?chainId}
The annualized trailing yield for OUSD, OETH, superOETHb over a given number of days
Number of days greater than 100 may produce unexpected results
Path Parameters
Name | Type | Description |
---|---|---|
Query Parameters
Name | Type | Description |
---|---|---|
200: OK
GET
https://api.originprotocol.com/api/v2/{token}/stats/{stat}{?chainId}
All available stats for OETH, OUSD and superOETHb
Path Parameters
Query Parameters
Available stats
200: OK
GET
https://api.originprotocol.com/api/v2/{symbol}/ratios{?chainId}
The current credits per token
Path Parameters
Query Parameters
200: OK
GET
https://api.originprotocol.com/api/v2/{symbol}/apr/history
The recent annualized historical yield for OUSD or OETH
Path Parameters
200: OK
GET
https://api.originprotocol.com/api/v2/{symbol}/collateral
A list of backing assets and their balances held by OUSD
Path Parameters
200: OK
GET
https://api.originprotocol.com/api/v2/{symbol}/strategies{?structured}
A list of OUSD's yield-earning strategies and its token balances
Path Parameters
Query Parameters
200: OK structured
GET
https://api.originprotocol.com/circulating-ogn
The number of Origin Tokens (OGN) in circulation
200: OK
GET
https://api.originprotocol.com/total-ogn
The total number of Origin Tokens (OGN) in existence
200: OK
GET
https://api.originprotocol.com/total-oeth
The total number of Origin Ether (OETH) tokens in existence
200: OK
GET
https://api.originprotocol.com/total-superoethb
The total number of Origin Dollar (OUSD) tokens in existence
200: OK
GET
https://api.originprotocol.com/api/v2/protocol-fees
Protocol revenue derived from OETH and OUSD performance fees
200: OK
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Stat | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
symbol*
String
ousd, oeth, superoethb
days
Number
Number of days
chainId
Number
chain id, defaults to 1
mainnet
symbol*
String
ousd, oeth, superoethb
stat
String
available Stat
chainId
Number
chain id, defaults to 1
mainnet
totalSupply
total supply (default)
apr
average APR
apy
average APY
apy14
trailing apy 14 days
apy30
trailing apy 30 days
apy7
trailing apy 7 days
blockNumber
latest computed block
fees
fee perceived
marketCapUSD
market cap
amoSupply
AMO supply
dripperWETH
WETH dripper
nonRebasingSupply
total non rebasing supply
rateETH
ETH price
rateUSD
USD price
rebasingSupply
total rebasing
wrappedSupply
total wrapped
yield
total yield
symbol*
String
ousd, oeth, superoethb
chainId
Number
chain id, defaults to 1
mainnet
symbol*
String
ousd or oeth
symbol*
String
ousd
symbol*
String
ousd
structured
String