Skip to main content

System Metadata

System Metadata APIs are designed to give you more information about the Nakji Ecosystem. Through the System Metadata APIs, you can get the full list of data streams that are available on Nakji Network and details of specific data streams.

Base URL: https://api.nakji.network/v1

Endpoints

/metadata/connectors

Returns a list of all available connectors that are available on Nakji network.

Request vars

0 GET variables.

Response vars

An array of strings of connector names.

Example

  curl -i -X GET "https://api.nakji.network/v1/metadata/connectors"

[
"nakji.aave.0_0_0",
"nakji.chi.0_0_0",
"nakji.eth2.0_0_0",
"nakji.solana.0_0_0",
"nakji.traderjoe.0_0_0",
...
]

/metadata/streams

Returns a list of all available data streams available on Nakji.

Request vars

0 GET variables.

Response vars

An array of JSON objects with the following properties:

  • name: name of the data stream
  • persisted: boolean value that tells you if the historical data for the data stream is available. If false, /data API is not available for the given data stream

Example

    # list all
curl -i -X GET "https://api.nakji.network/v1/metadata/streams"

# Response format is `json`
[
{
"name": "nakji.solana.0_0_0.solana_reward",
"persisted": true
},
{
"name": "nakji.perpetual.0_0_0.stakedperptoken_staked",
"persisted": false
},
{...}
]

/metadata/stream/:name

Given a stream name, return a human readable overview of the data structure that can be expected from this stream.

note

This endpoint is not stable and may be updated at any time. Use this for reference only. Use programmatically at your own risk.

Request vars

0 GET variables. :name is the name of the stream. (Eg. nakji.solana.0_0_0.solana_reward).

Example

curl -i -X GET https://api.nakji.network/v1/metadata/stream/nakji.uniswapv3.0_0_0.pool_collectprotocol

# pool.CollectProtocol

ts: google.protobuf.Timestamp
seconds: int64
nanos: int32
sender: bytes
recipient: bytes
amount0: bytes