Get Oracle Metric Summary

Reads one series from a metric provider's source and returns the market-listing figures the tokenization form prefills from. The source is read on every request; nothing is cached.

A figure the source does not publish comes back as null, never as 0, so a published zero stays distinguishable from "no value": leave those inputs as they are.
name and description come from the provider's entry for code in its codes list when there is one, otherwise from the provider itself.
rental_income carries its currency: it is expressed in the platform's active currency token for the provider's fiat_currency.

Amounts are decimal strings; see Amounts and Percentages.

Required permission: oracle:view

Request

GET /v2/admin/oracle-metrics/{oracle_metric_id}/summary

Parameters

Name	Type	In	Description
`oracle_metric_id`	string	path	Required. Metric provider id (24-character hex)
`code`	string	query	Required. Series code to read

Headers

Name	Description
`Authorization`	Required. `Bearer <access_token>`

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/oracle-metrics/6a5d0206379ebd02e53bf1a1/summary?code=TOGG1' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "name": "Togg Şarj İstasyonu 1",
  "code": "TOGG1",
  "description": "İstanbul Ataşehir hızlı şarj istasyonu",
  "term_duration_in_months": 36,
  "min_purchase_quantity": 1,
  "max_purchase_quantity": null,
  "min_tokens_required_for_rental_income": 10,
  "rental_payment_period_in_days": 30,
  "listed_supply": 5000,
  "rental_income": {
    "id": "68fe8c129367fd414b227c7a",
    "amount": "12500.75",
    "decimal": 6,
    "symbol": "ISCN",
    "address": "0x073c0196e516a0e77b1c804d1825fb1bad23895d"
  }
}

Response Fields

Field	Type	Description
`name`	string	Display name of the series
`code`	string	The requested code
`description`	string	Description of the series
`term_duration_in_months`	integer \| null	Term of the asset in months
`min_purchase_quantity`	integer \| null	Minimum tokens per purchase
`max_purchase_quantity`	integer \| null	Maximum tokens per purchase
`min_tokens_required_for_rental_income`	integer \| null	Tokens a holder needs to receive rental income
`rental_payment_period_in_days`	integer \| null	Rental payment period in days
`listed_supply`	integer \| null	Number of tokens listed
`rental_income`	object \| null	Rental income, in the currency token of the provider's `fiat_currency`
`rental_income.id`	string	Currency token id
`rental_income.amount`	string	Rental income, decimal string
`rental_income.decimal`	integer	Decimals of the currency token
`rental_income.symbol`	string	Currency token symbol
`rental_income.address`	string	Currency token contract address (empty when it has none)

Errors

Status	Code	Description
400	`10015`	`code` is missing — see `details`
400	`10000`	`oracle_metric_id` is not a valid 24-character hex id
400	`10001`	Metric provider not found or deleted (domain `53`)
400	`-1`	The summary could not be built: the source has no data for the code, a value is not a number, or the source publishes a rental income but no active currency token exists for the provider's `fiat_currency`. `message` names which
500	`10000`	The source or a store could not be reached

See Errors for the error format and common codes.

Request​

Parameters​

Headers​

Example​

Response​

Response Fields​

Errors​