API docs by Redocly

Microgard Public API (1.0.0)

Download OpenAPI specification:Download

E-mail: [email protected]

The Microgard Public API queries THORChain and any chains linked via the Bifröst and prepares information about the network to be readily available for public users. The API parses transaction event data from THORChain and stores them in a time-series database to make time-dependent queries easy.

Specification

Documentation

Swagger/OpenAPI 3.0 specification generated documents.

Responses

Swagger File

Returns human and machine readable swagger/openapi specification

Responses

Depth and Price History

Returns the asset and rune depths and price. The values report the state at the end of each interval.

History endpoint has two modes:

  • With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries.

  • Without Interval parameter a single From..To search is performed with exact timestamps.

  • Interval: possible values: 5min, hour, day, week, month, quarter, year.

  • count: [1..400]. Defines number of intervals. Don't provide if Interval is missing.

  • from/to: optional int, unix second.

Possible usages with interval.

  • last 10 days: ?interval=day&count=10
  • last 10 days before to: ?interval=day&count=10&to=1608825600
  • next 10 days after from: ?interval=day&count=10&from=1606780800
  • Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600

Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query.

Possible configurations without interval:

  • exact search for one time frame: ?from=1606780899&to=1608825600
  • one time frame until now: ?from=1606780899
  • from chain start until now: no query parameters
path Parameters
pool
required
string

Return stats for this single pool.

query Parameters
interval
string
Enum: "5min" "hour" "day" "week" "month" "quarter" "year"
Example: interval=day

Interval of calculations

count
integer
Example: count=30

Number of intervals to return. Should be between [1..400].

to
integer <int64>
Example: to=1608825600

End time of the query as unix timestamp. If only count is given, defaults to now.

from
integer <int64>
Example: from=1606780800

Start time of the query as unix timestamp

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "intervals": [
    ]
}

Get historical OHLCV (Open, High, Low, Close, Volume) of a pool

Returns the asset and rune depths and price. The values report the state at the end of each interval.

History endpoint has two modes:

  • With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries.

  • Without Interval parameter a single From..To search is performed with exact timestamps.

  • Interval: possible values: 5min, hour, day, week, month, quarter, year.

  • count: [1..400]. Defines number of intervals. Don't provide if Interval is missing.

  • from/to: optional int, unix second.

Possible usages with interval.

  • last 10 days: ?interval=day&count=10
  • last 10 days before to: ?interval=day&count=10&to=1608825600
  • next 10 days after from: ?interval=day&count=10&from=1606780800
  • Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600

Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query.

Possible configurations without interval:

  • exact search for one time frame: ?from=1606780899&to=1608825600
  • one time frame until now: ?from=1606780899
  • from chain start until now: no query parameters
path Parameters
pool
required
string

Return stats for this single pool.

query Parameters
interval
string
Enum: "5min" "hour" "day" "week" "month" "quarter" "year"
Example: interval=day

Interval of calculations

count
integer
Example: count=30

Number of intervals to return. Should be between [1..400].

to
integer <int64>
Example: to=1608825600

End time of the query as unix timestamp. If only count is given, defaults to now.

from
integer <int64>
Example: from=1606780800

Start time of the query as unix timestamp

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "intervals": [
    ]
}

THORSwap Swaps History

Returns swap count, volume, fees, slip in specified interval routed by THORSwap. If pool is not specified returns for all pools

History endpoint has two modes:

  • With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries.

  • Without Interval parameter a single From..To search is performed with exact timestamps.

  • Interval: possible values: 5min, hour, day, week, month, quarter, year.

  • count: [1..400]. Defines number of intervals. Don't provide if Interval is missing.

  • from/to: optional int, unix second.

Possible usages with interval.

  • last 10 days: ?interval=day&count=10
  • last 10 days before to: ?interval=day&count=10&to=1608825600
  • next 10 days after from: ?interval=day&count=10&from=1606780800
  • Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600

Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query.

Possible configurations without interval:

  • exact search for one time frame: ?from=1606780899&to=1608825600
  • one time frame until now: ?from=1606780899
  • from chain start until now: no query parameters
query Parameters
pool
string

Return history given pool. Returns sum of all pools if missing.

interval
string
Enum: "5min" "hour" "day" "week" "month" "quarter" "year"
Example: interval=day

Interval of calculations

count
integer
Example: count=30

Number of intervals to return. Should be between [1..400].

to
integer <int64>
Example: to=1608825600

End time of the query as unix timestamp. If only count is given, defaults to now.

from
integer <int64>
Example: from=1606780800

Start time of the query as unix timestamp

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "intervals": [
    ]
}

Swaps History

Returns swap count, volume, fees, slip in specified interval. If pool is not specified returns for all pools

History endpoint has two modes:

  • With Interval parameter it returns a series of time buckets. From and To dates will be rounded to the Interval boundaries.

  • Without Interval parameter a single From..To search is performed with exact timestamps.

  • Interval: possible values: 5min, hour, day, week, month, quarter, year.

  • count: [1..400]. Defines number of intervals. Don't provide if Interval is missing.

  • from/to: optional int, unix second.

Possible usages with interval.

  • last 10 days: ?interval=day&count=10
  • last 10 days before to: ?interval=day&count=10&to=1608825600
  • next 10 days after from: ?interval=day&count=10&from=1606780800
  • Days between from and to. From defaults to start of chain, to defaults to now. Only the first 400 intervals are returned: interval=day&from=1606780800&to=1608825600

Pagination is possible with from&count and then using the returned meta.endTime as the From parameter of the next query.

Possible configurations without interval:

  • exact search for one time frame: ?from=1606780899&to=1608825600
  • one time frame until now: ?from=1606780899
  • from chain start until now: no query parameters
query Parameters
pool
string

Return history given pool. Returns sum of all pools if missing.

interval
string
Enum: "5min" "hour" "day" "week" "month" "quarter" "year"
Example: interval=day

Interval of calculations

count
integer
Example: count=30

Number of intervals to return. Should be between [1..400].

to
integer <int64>
Example: to=1608825600

End time of the query as unix timestamp. If only count is given, defaults to now.

from
integer <int64>
Example: from=1606780800

Start time of the query as unix timestamp

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "intervals": [
    ]
}

Full Members List

Returns an array containing the addresses for all pool members. Addresses are only shown once. If there's both a RUNE address and an asset address for a member, only the RUNE address will be shown.

query Parameters
pool
string

Return only members present in the pool.

Responses

Response samples

Content type
application/json
{
  • "pools": [
    ]
}

Saver Details

Returns an array of statistics for all the savers associated with a given member address. Query can also be multiple addresses should be seperated by comma (',')

path Parameters
address
required
string
Example: bnb1jxfh2g85q3v0tdq56fnevx6xcxtcnhtsmcu64m,bc1qcxssye4j6730h7ehgega3gyykkuwgdgmmpu62n

Address to match the saver. an asset address should be given.

Responses

Response samples

Content type
application/json
{
  • "pools": [
    ]
}