RSS3 Documentation

RSS3 Data Sublayer API

On the RSS3 Network, Global Indexers (GIs) are responsible for facilitating coordination among RSS3 Nodes, engaging with the Value Sublayer (VSL) and performing critical functions such as Network Rewards calculation and slashing enforcement. Global Indexers also provide Data Sublayer (DSL) API to process data queries and offer the Network’s insight via the Network Transparency API (NTA).

GET
/decentralized/tx/{id}

Retrieve Activity by ID

This endpoint retrieves the details of a specified decentralized transaction activity by its ID. You can specify additional query parameters to limit the number of actions retrieved and paginate through them.

/decentralized/tx/{id}

Path Parameters

id
Required
string

Retrieve details for the specified activity ID

Query Parameters

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

action_pageinteger

Specify the pagination for actions

Default: 1Minimum: 1
curl -X GET "https://gi.rss3.io/decentralized/tx/string?action_limit=50&action_page=1"

A successful response containing the details of the specified activity. The response includes the activity ID, timestamp, and a list of actions performed within the activity.

{
  "data": {
    "id": "0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3",
    "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "network": "ethereum",
    "from": "0xBAB4d1f27bAA7762a4d822B80C647F715922492f",
    "to": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
    "index": 0,
    "platform": "1inch",
    "success": true,
    "tag": "transaction",
    "type": "transfer",
    "calldata": {
      "function_hash": "0x4022b75e"
    },
    "direction": "out",
    "fee": {
      "amount": "315699955320960",
      "decimal": 18
    },
    "timestamp": 1718689727,
    "total_actions": 1,
    "actions": [
      {
        "tag": "transaction",
        "type": "transfer",
        "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "to": "0xefC5f77c5AD5DB85bc287E80d8c3B88c3f27662C",
        "metadata": {
          "address": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
          "value": "10000000000000000000000",
          "name": "PlayDoge",
          "symbol": "PLAY",
          "decimals": 18,
          "standard": "ERC-20"
        },
        "related_urls": [
          "https://etherscan.io/tx/0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3"
        ]
      }
    ]
  },
  "meta": {
    "totalPages": 1
  }
}
GET
/decentralized/{account}

Retrieve Account Activities

This endpoint retrieves the activities associated with a specified account in the decentralized system. Use query parameters to filter results by action limits, timestamps, status, direction, and more.

/decentralized/{account}?direction=out

Path Parameters

account
Required
string

Retrieve activities from the specified account. This account is a unique identifier within the decentralized system.

Query Parameters

limitinteger

Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

since_timestampinteger

Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.

until_timestampinteger

Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.

successboolean

Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.

directionstring

Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.

Value in: "in" | "out" | "self"

networkarray<string>

Retrieve activities from the specified network(s). You can specify one or more networks.

tagarray<string>

Retrieve activities from the specified tag(s). Tags can be used to categorize activities.

typearray<string>

Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.

platformarray<string>

Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.

curl -X GET "https://gi.rss3.io/decentralized/string?limit=100&action_limit=50&cursor=string&since_timestamp=0&until_timestamp=0&success=true&direction=out&network=%5B%0A++%22ethereum%22%0A%5D&tag=%5B%0A++%22transaction%22%0A%5D&type=%5B%0A++%22transfer%22%0A%5D&platform=%5B%0A++%221inch%22%0A%5D"

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3",
      "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "network": "ethereum",
      "from": "0xBAB4d1f27bAA7762a4d822B80C647F715922492f",
      "to": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
      "index": 0,
      "platform": "1inch",
      "success": true,
      "tag": "transaction",
      "type": "transfer",
      "calldata": {
        "function_hash": "0x4022b75e"
      },
      "direction": "out",
      "fee": {
        "amount": "315699955320960",
        "decimal": 18
      },
      "timestamp": 1718689727,
      "total_actions": 1,
      "actions": [
        {
          "tag": "transaction",
          "type": "transfer",
          "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "to": "0xefC5f77c5AD5DB85bc287E80d8c3B88c3f27662C",
          "metadata": {
            "address": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
            "value": "10000000000000000000000",
            "name": "PlayDoge",
            "symbol": "PLAY",
            "decimals": 18,
            "standard": "ERC-20"
          },
          "related_urls": [
            "https://etherscan.io/tx/0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
POST
/decentralized/accounts

Batch Get Accounts Activities

Retrieve activities associated with multiple accounts on all compatible networks. You can use various query parameters to filter and paginate the results, including limits on the number of activities and actions, timestamps, success status, direction, and more.

/decentralized/accounts

Request Body

application/jsonRequired

Request body for batch retrieving activities for multiple accounts

accountsarray<string>

List of accounts to retrieve activities for

limitinteger

Specify the number of activities to retrieve

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 10Minimum: 1Maximum: 20

cursorstring

Specify the cursor used for pagination

since_timestampinteger

Retrieve activities starting from this timestamp

until_timestampinteger

Retrieve activities up to this timestamp

successboolean

Retrieve activities based on success status

directionstring

The direction of an activity.

Value in: "in" | "out" | "self"

networkarray<string>

Retrieve activities from the specified network(s)

tagarray<string>

Retrieve activities for the specified tag(s)

typearray<string>

Retrieve activities for the specified type(s)

platformarray<string>

Retrieve activities from the specified platform(s)

curl -X POST "https://gi.rss3.io/decentralized/accounts" \
  -H "Content-Type: application/json" \
  -d '{
    "accounts": [
      "0xd8da6bf26964af9d7eed9e03e53415d37aa96045"
    ],
    "limit": 20,
    "action_limit": 10,
    "cursor": "string",
    "since_timestamp": 0,
    "until_timestamp": 0,
    "success": true,
    "direction": "out",
    "network": [
      "ethereum"
    ],
    "tag": [
      "transaction"
    ],
    "type": [
      "transfer"
    ],
    "platform": [
      "1inch"
    ]
  }'

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3",
      "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "network": "ethereum",
      "from": "0xBAB4d1f27bAA7762a4d822B80C647F715922492f",
      "to": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
      "index": 0,
      "platform": "1inch",
      "success": true,
      "tag": "transaction",
      "type": "transfer",
      "calldata": {
        "function_hash": "0x4022b75e"
      },
      "direction": "out",
      "fee": {
        "amount": "315699955320960",
        "decimal": 18
      },
      "timestamp": 1718689727,
      "total_actions": 1,
      "actions": [
        {
          "tag": "transaction",
          "type": "transfer",
          "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "to": "0xefC5f77c5AD5DB85bc287E80d8c3B88c3f27662C",
          "metadata": {
            "address": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
            "value": "10000000000000000000000",
            "name": "PlayDoge",
            "symbol": "PLAY",
            "decimals": 18,
            "standard": "ERC-20"
          },
          "related_urls": [
            "https://etherscan.io/tx/0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET
/decentralized/network/{network}

Retrieve Network Activities

Retrieve a list of activities from the specified decentralized network. This endpoint allows you to filter activities by various parameters such as limit, timestamp, success status, and more.

/decentralized/network/{network}?direction=out

Path Parameters

network
Required
string

Retrieve activities from the specified network.

Query Parameters

limitinteger

Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

since_timestampinteger

Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.

until_timestampinteger

Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.

successboolean

Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.

directionstring

Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.

Value in: "in" | "out" | "self"

tagarray<string>

Retrieve activities for the specified tag(s).

typearray<string>

Retrieve activities for the specified type(s).

platformarray<string>

Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.

curl -X GET "https://gi.rss3.io/decentralized/network/string?limit=100&action_limit=50&cursor=string&since_timestamp=0&until_timestamp=0&success=true&direction=out&tag=%5B%0A++%22transaction%22%0A%5D&type=%5B%0A++%22transfer%22%0A%5D&platform=%5B%0A++%221inch%22%0A%5D"

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3",
      "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "network": "ethereum",
      "from": "0xBAB4d1f27bAA7762a4d822B80C647F715922492f",
      "to": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
      "index": 0,
      "platform": "1inch",
      "success": true,
      "tag": "transaction",
      "type": "transfer",
      "calldata": {
        "function_hash": "0x4022b75e"
      },
      "direction": "out",
      "fee": {
        "amount": "315699955320960",
        "decimal": 18
      },
      "timestamp": 1718689727,
      "total_actions": 1,
      "actions": [
        {
          "tag": "transaction",
          "type": "transfer",
          "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "to": "0xefC5f77c5AD5DB85bc287E80d8c3B88c3f27662C",
          "metadata": {
            "address": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
            "value": "10000000000000000000000",
            "name": "PlayDoge",
            "symbol": "PLAY",
            "decimals": 18,
            "standard": "ERC-20"
          },
          "related_urls": [
            "https://etherscan.io/tx/0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET
/decentralized/platform/{platform}

Retrieve Platform Activities

Retrieve a list of activities from the specified decentralized platform. This endpoint allows you to filter activities by various parameters such as limit, timestamp, success status, and more.

/decentralized/platform/{platform}?direction=out

Path Parameters

platform
Required
string

Retrieve activities from the specified platform.

Query Parameters

limitinteger

Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

since_timestampinteger

Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.

until_timestampinteger

Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.

successboolean

Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.

directionstring

Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.

Value in: "in" | "out" | "self"

tagarray<string>

Retrieve activities for the specified tag(s).

typearray<string>

Retrieve activities for the specified type(s).

networkarray<string>

Retrieve activities from the specified network(s). You can specify one or more networks.

curl -X GET "https://gi.rss3.io/decentralized/platform/string?limit=100&action_limit=50&cursor=string&since_timestamp=0&until_timestamp=0&success=true&direction=out&tag=%5B%0A++%22transaction%22%0A%5D&type=%5B%0A++%22transfer%22%0A%5D&network=%5B%0A++%22ethereum%22%0A%5D"

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3",
      "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "network": "ethereum",
      "from": "0xBAB4d1f27bAA7762a4d822B80C647F715922492f",
      "to": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
      "index": 0,
      "platform": "1inch",
      "success": true,
      "tag": "transaction",
      "type": "transfer",
      "calldata": {
        "function_hash": "0x4022b75e"
      },
      "direction": "out",
      "fee": {
        "amount": "315699955320960",
        "decimal": 18
      },
      "timestamp": 1718689727,
      "total_actions": 1,
      "actions": [
        {
          "tag": "transaction",
          "type": "transfer",
          "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "to": "0xefC5f77c5AD5DB85bc287E80d8c3B88c3f27662C",
          "metadata": {
            "address": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
            "value": "10000000000000000000000",
            "name": "PlayDoge",
            "symbol": "PLAY",
            "decimals": 18,
            "standard": "ERC-20"
          },
          "related_urls": [
            "https://etherscan.io/tx/0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET
/rss/{path}

Retrieve RSS Activity by Path

/rss/{path}

Path Parameters

path
Required
string

Retrieve details for the specified RSS path

curl -X GET "https://gi.rss3.io/rss/string"

A successful response with the activities from rss feed.

{
  "data": [
    {
      "id": "0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3",
      "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "network": "ethereum",
      "from": "0xBAB4d1f27bAA7762a4d822B80C647F715922492f",
      "to": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
      "index": 0,
      "platform": "1inch",
      "success": true,
      "tag": "transaction",
      "type": "transfer",
      "calldata": {
        "function_hash": "0x4022b75e"
      },
      "direction": "out",
      "fee": {
        "amount": "315699955320960",
        "decimal": 18
      },
      "timestamp": 1718689727,
      "total_actions": 1,
      "actions": [
        {
          "tag": "transaction",
          "type": "transfer",
          "from": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "to": "0xefC5f77c5AD5DB85bc287E80d8c3B88c3f27662C",
          "metadata": {
            "address": "0x7964B6A8aE5a71409e7E17a5b2669903A27997Ac",
            "value": "10000000000000000000000",
            "name": "PlayDoge",
            "symbol": "PLAY",
            "decimals": 18,
            "standard": "ERC-20"
          },
          "related_urls": [
            "https://etherscan.io/tx/0x840e42d573ebe1ff27a9e4914573b4e0518fcd685c7f9331d319abe854f780e3"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET
/federated/tx/{id}

Retrieve Federated Activity by ID (Beta)

This endpoint retrieves the details of a specified federated activity by its ID. You can also specify additional query parameters to limit the number of actions retrieved and to paginate through actions.

/federated/tx/{id}

Path Parameters

id
Required
string

Retrieve details for the specified federated activity ID

Query Parameters

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

action_pageinteger

Specify the pagination for actions

Default: 1Minimum: 1
curl -X GET "https://gi.rss3.io/federated/tx/string?action_limit=50&action_page=1"

A successful response containing the details of the specified federated activity. The response includes the activity ID, timestamp, and a list of actions performed within the activity.

{
  "data": {
    "id": "https://universeodon.com/users/woofers/statuses/113324128515491294/activity",
    "owner": "@georgetakei@universeodon.com",
    "network": "mastodon",
    "from": "@woofers@universeodon.com",
    "to": "@georgetakei@universeodon.com",
    "index": 0,
    "platform": "Mastodon",
    "success": true,
    "tag": "social",
    "type": "comment",
    "direction": "out",
    "timestamp": 1729188972,
    "total_actions": 1,
    "actions": [
      {
        "tag": "social",
        "type": "comment",
        "platform": "Mastodon",
        "from": "@woofers@universeodon.com",
        "to": "@georgetakei@universeodon.com",
        "metadata": {
          "handle": "@woofers@universeodon.com",
          "body": "@ georgetakei ( https://universeodon.com/@georgetakei ) now hold on just a minute...\n\n# woof ( https://universeodon.com/tags/woof )",
          "publication_id": "113324128515491294",
          "tags": [
            "@georgetakei",
            "#woof"
          ],
          "author_url": "https://universeodon.com/users/woofers",
          "timestamp": 1729188972,
          "target": {
            "handle": "@georgetakei@universeodon.com",
            "body": "Just a little treat.",
            "media": [
              {
                "address": "https://media.universeodon.com/media_attachments/files/113/319/346/314/075/495/original/26e989bcf15840a6.png",
                "mime_type": "image/png"
              }
            ],
            "publication_id": "113319346448373294",
            "author_url": "https://universeodon.com/users/georgetakei",
            "timestamp": 1729116004
          },
          "target_url": "https://universeodon.com/users/georgetakei/statuses/113319346448373294"
        },
        "related_urls": [
          "https://universeodon.com/users/woofers/statuses/113324128515491294"
        ]
      }
    ]
  },
  "meta": {
    "totalPages": 1
  }
}
GET
/federated/{account}

Retrieve Federated Account Activities (Beta)

This endpoint retrieves the activities associated with a specified account in the federated system. You can use various query parameters to filter and paginate the results, including limits on the number of activities and actions, timestamps, success status, direction, and more.

/federated/{account}?direction=out

Path Parameters

account
Required
string

Retrieve activities from the specified account. This account is a unique identifier within the federated system.

Query Parameters

limitinteger

Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

since_timestampinteger

Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.

until_timestampinteger

Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.

successboolean

Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.

directionstring

Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.

Value in: "in" | "out" | "self"

networkarray<string>

Retrieve activities from the specified federated network(s). You can specify one or more federated networks.

tagarray<string>

Retrieve activities from the specified tag(s). Tags can be used to categorize activities.

typearray<string>

Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.

platformarray<string>

Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.

curl -X GET "https://gi.rss3.io/federated/string?limit=100&action_limit=50&cursor=string&since_timestamp=0&until_timestamp=0&success=true&direction=out&network=%5B%0A++%22mastodon%22%0A%5D&tag=%5B%0A++%22social%22%0A%5D&type=%5B%0A++%22post%22%0A%5D&platform=%5B%0A++%22Mastodon%22%0A%5D"

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "https://universeodon.com/users/woofers/statuses/113324128515491294/activity",
      "owner": "@georgetakei@universeodon.com",
      "network": "mastodon",
      "from": "@woofers@universeodon.com",
      "to": "@georgetakei@universeodon.com",
      "index": 0,
      "platform": "Mastodon",
      "success": true,
      "tag": "social",
      "type": "comment",
      "direction": "out",
      "timestamp": 1729188972,
      "total_actions": 1,
      "actions": [
        {
          "tag": "social",
          "type": "comment",
          "platform": "Mastodon",
          "from": "@woofers@universeodon.com",
          "to": "@georgetakei@universeodon.com",
          "metadata": {
            "handle": "@woofers@universeodon.com",
            "body": "@ georgetakei ( https://universeodon.com/@georgetakei ) now hold on just a minute...\n\n# woof ( https://universeodon.com/tags/woof )",
            "publication_id": "113324128515491294",
            "tags": [
              "@georgetakei",
              "#woof"
            ],
            "author_url": "https://universeodon.com/users/woofers",
            "timestamp": 1729188972,
            "target": {
              "handle": "@georgetakei@universeodon.com",
              "body": "Just a little treat.",
              "media": [
                {
                  "address": "https://media.universeodon.com/media_attachments/files/113/319/346/314/075/495/original/26e989bcf15840a6.png",
                  "mime_type": "image/png"
                }
              ],
              "publication_id": "113319346448373294",
              "author_url": "https://universeodon.com/users/georgetakei",
              "timestamp": 1729116004
            },
            "target_url": "https://universeodon.com/users/georgetakei/statuses/113319346448373294"
          },
          "related_urls": [
            "https://universeodon.com/users/woofers/statuses/113324128515491294"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
POST
/federated/accounts

Batch Get Federated Accounts Activities (Beta)

Retrieve activities associated with multiple accounts on all compatible networks. You can use various query parameters to filter and paginate the results, including limits on the number of activities and actions, timestamps, success status, direction, and more.

/federated/accounts

Request Body

application/jsonRequired

Request body for batch retrieving activities for multiple federated accounts

accountsarray<string>

List of federated accounts to retrieve activities

limitinteger

Specify the number of activities to retrieve

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 10Minimum: 1Maximum: 20

cursorstring

Specify the cursor used for pagination

since_timestampinteger

Retrieve activities starting from this timestamp

until_timestampinteger

Retrieve activities up to this timestamp

successboolean

Retrieve activities based on success status

directionstring

The direction of an activity.

Value in: "in" | "out" | "self"

networkstring

Retrieve activities from the specified network(s)

tagstring

Retrieve activities for the specified tag(s)

typearray<string>

Retrieve activities for the specified type(s)

platformstring

Retrieve activities from the specified platform(s)

curl -X POST "https://gi.rss3.io/federated/accounts" \
  -H "Content-Type: application/json" \
  -d '{
    "accounts": [
      "@hauptstadtzoos@mastodon.berlin",
      "@nummycreations@mstdn.business"
    ],
    "limit": 20,
    "action_limit": 10,
    "cursor": "string",
    "since_timestamp": 0,
    "until_timestamp": 0,
    "success": true,
    "direction": "out",
    "network": "string",
    "tag": "social",
    "type": [
      "post",
      "comment",
      "share"
    ],
    "platform": "Mastodon"
  }'

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "https://universeodon.com/users/woofers/statuses/113324128515491294/activity",
      "owner": "@georgetakei@universeodon.com",
      "network": "mastodon",
      "from": "@woofers@universeodon.com",
      "to": "@georgetakei@universeodon.com",
      "index": 0,
      "platform": "Mastodon",
      "success": true,
      "tag": "social",
      "type": "comment",
      "direction": "out",
      "timestamp": 1729188972,
      "total_actions": 1,
      "actions": [
        {
          "tag": "social",
          "type": "comment",
          "platform": "Mastodon",
          "from": "@woofers@universeodon.com",
          "to": "@georgetakei@universeodon.com",
          "metadata": {
            "handle": "@woofers@universeodon.com",
            "body": "@ georgetakei ( https://universeodon.com/@georgetakei ) now hold on just a minute...\n\n# woof ( https://universeodon.com/tags/woof )",
            "publication_id": "113324128515491294",
            "tags": [
              "@georgetakei",
              "#woof"
            ],
            "author_url": "https://universeodon.com/users/woofers",
            "timestamp": 1729188972,
            "target": {
              "handle": "@georgetakei@universeodon.com",
              "body": "Just a little treat.",
              "media": [
                {
                  "address": "https://media.universeodon.com/media_attachments/files/113/319/346/314/075/495/original/26e989bcf15840a6.png",
                  "mime_type": "image/png"
                }
              ],
              "publication_id": "113319346448373294",
              "author_url": "https://universeodon.com/users/georgetakei",
              "timestamp": 1729116004
            },
            "target_url": "https://universeodon.com/users/georgetakei/statuses/113319346448373294"
          },
          "related_urls": [
            "https://universeodon.com/users/woofers/statuses/113324128515491294"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET
/federated/network/{network}

Retrieve Federated Network Activities (Beta)

Retrieve a list of activities from the specified federated network. This endpoint allows you to filter activities by various parameters such as limit, timestamp, success status, and more.

/federated/network/{network}?direction=out

Path Parameters

network
Required
string

Retrieve activities from the specified federated network.

Query Parameters

limitinteger

Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

since_timestampinteger

Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.

until_timestampinteger

Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.

successboolean

Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.

directionstring

Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.

Value in: "in" | "out" | "self"

tagarray<string>

Retrieve activities from the specified tag(s). Tags can be used to categorize activities.

typearray<string>

Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.

platformarray<string>

Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.

curl -X GET "https://gi.rss3.io/federated/network/string?limit=100&action_limit=50&cursor=string&since_timestamp=0&until_timestamp=0&success=true&direction=out&tag=%5B%0A++%22social%22%0A%5D&type=%5B%0A++%22post%22%0A%5D&platform=%5B%0A++%22Mastodon%22%0A%5D"

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "https://universeodon.com/users/woofers/statuses/113324128515491294/activity",
      "owner": "@georgetakei@universeodon.com",
      "network": "mastodon",
      "from": "@woofers@universeodon.com",
      "to": "@georgetakei@universeodon.com",
      "index": 0,
      "platform": "Mastodon",
      "success": true,
      "tag": "social",
      "type": "comment",
      "direction": "out",
      "timestamp": 1729188972,
      "total_actions": 1,
      "actions": [
        {
          "tag": "social",
          "type": "comment",
          "platform": "Mastodon",
          "from": "@woofers@universeodon.com",
          "to": "@georgetakei@universeodon.com",
          "metadata": {
            "handle": "@woofers@universeodon.com",
            "body": "@ georgetakei ( https://universeodon.com/@georgetakei ) now hold on just a minute...\n\n# woof ( https://universeodon.com/tags/woof )",
            "publication_id": "113324128515491294",
            "tags": [
              "@georgetakei",
              "#woof"
            ],
            "author_url": "https://universeodon.com/users/woofers",
            "timestamp": 1729188972,
            "target": {
              "handle": "@georgetakei@universeodon.com",
              "body": "Just a little treat.",
              "media": [
                {
                  "address": "https://media.universeodon.com/media_attachments/files/113/319/346/314/075/495/original/26e989bcf15840a6.png",
                  "mime_type": "image/png"
                }
              ],
              "publication_id": "113319346448373294",
              "author_url": "https://universeodon.com/users/georgetakei",
              "timestamp": 1729116004
            },
            "target_url": "https://universeodon.com/users/georgetakei/statuses/113319346448373294"
          },
          "related_urls": [
            "https://universeodon.com/users/woofers/statuses/113324128515491294"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET
/federated/platform/{platform}

Retrieve Federated Platform Activities (Beta)

Retrieve a list of activities from the specified federated platform. This endpoint allows you to filter activities by various parameters such as limit, timestamp, success status, and more.

/federated/platform/{platform}?direction=out

Path Parameters

platform
Required
string

Retrieve activities from the specified federated platform.

Query Parameters

limitinteger

Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

since_timestampinteger

Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.

until_timestampinteger

Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.

successboolean

Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.

directionstring

Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.

Value in: "in" | "out" | "self"

tagarray<string>

Retrieve activities from the specified tag(s). Tags can be used to categorize activities.

typearray<string>

Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.

networkarray<string>

Retrieve activities from the specified federated network(s). You can specify one or more federated networks.

curl -X GET "https://gi.rss3.io/federated/platform/string?limit=100&action_limit=50&cursor=string&since_timestamp=0&until_timestamp=0&success=true&direction=out&tag=%5B%0A++%22social%22%0A%5D&type=%5B%0A++%22post%22%0A%5D&network=%5B%0A++%22mastodon%22%0A%5D"

A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.

{
  "data": [
    {
      "id": "https://universeodon.com/users/woofers/statuses/113324128515491294/activity",
      "owner": "@georgetakei@universeodon.com",
      "network": "mastodon",
      "from": "@woofers@universeodon.com",
      "to": "@georgetakei@universeodon.com",
      "index": 0,
      "platform": "Mastodon",
      "success": true,
      "tag": "social",
      "type": "comment",
      "direction": "out",
      "timestamp": 1729188972,
      "total_actions": 1,
      "actions": [
        {
          "tag": "social",
          "type": "comment",
          "platform": "Mastodon",
          "from": "@woofers@universeodon.com",
          "to": "@georgetakei@universeodon.com",
          "metadata": {
            "handle": "@woofers@universeodon.com",
            "body": "@ georgetakei ( https://universeodon.com/@georgetakei ) now hold on just a minute...\n\n# woof ( https://universeodon.com/tags/woof )",
            "publication_id": "113324128515491294",
            "tags": [
              "@georgetakei",
              "#woof"
            ],
            "author_url": "https://universeodon.com/users/woofers",
            "timestamp": 1729188972,
            "target": {
              "handle": "@georgetakei@universeodon.com",
              "body": "Just a little treat.",
              "media": [
                {
                  "address": "https://media.universeodon.com/media_attachments/files/113/319/346/314/075/495/original/26e989bcf15840a6.png",
                  "mime_type": "image/png"
                }
              ],
              "publication_id": "113319346448373294",
              "author_url": "https://universeodon.com/users/georgetakei",
              "timestamp": 1729116004
            },
            "target_url": "https://universeodon.com/users/georgetakei/statuses/113319346448373294"
          },
          "related_urls": [
            "https://universeodon.com/users/woofers/statuses/113324128515491294"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET
/nta/bridgings/transactions

Retrieve bridging transactions

Retrieve a list of bridging transactions based on various query parameters such as cursor, sender, receiver, address, transaction type, and limit. This endpoint allows users to filter transactions to get precise data related to deposits and withdrawals. The response includes transaction details, such as sender and receiver addresses, token information, and related events like deposit initialization and finalization. Use this endpoint for monitoring, auditing, or analyzing bridging transactions. The 'cursor' parameter can be used for pagination to fetch subsequent sets of results.

/nta/bridgings/transactions

Query Parameters

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

senderstring

Sender address

receiverstring

Receiver address

addressstring

Address involved in the transaction

typestring

Type of bridging transaction

Value in: "deposit" | "withdraw"

limitinteger

Limit the number of results

Default: 50
curl -X GET "https://gi.rss3.io/nta/bridgings/transactions?cursor=string&sender=string&receiver=string&address=string&type=deposit&limit=50"

List of bridging transactions retrieved successfully

{
  "data": [
    {
      "id": "0x2af31b2a2708d5c9074074c578d3c521bd4385875e500f274fce52d3074460aa",
      "sender": "0x3b6d02a24df681ffdf621d35d70aba7adaac07c1",
      "receiver": "0x3b6d02a24df681ffdf621d35d70aba7adaac07c1",
      "token": {
        "address": {
          "l1": "0xc98d64da73a6616c42117b582e832812e7b8d57f",
          "l2": "0x4200000000000000000000000000000000000042"
        },
        "value": "10000000000000000000000"
      },
      "event": {
        "deposit": {
          "initialized": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          },
          "finalized": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          }
        },
        "withdraw": {
          "initialized": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          },
          "proved": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          },
          "finalized": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          }
        }
      }
    }
  ]
}
GET
/nta/bridgings/transactions/{transaction_hash}

Retrieve bridging transaction by hash

Retrieve bridging transaction details by its transaction hash. This endpoint provides comprehensive data about a single transaction, including sender, receiver, token details, and related events.

/nta/bridgings/transactions/{transaction_hash}

Path Parameters

transaction_hash
Required
string

The unique hash of the bridging transaction

curl -X GET "https://gi.rss3.io/nta/bridgings/transactions/string"

Bridging transaction details fetched successfully

{
  "data": {
    "id": "0x2af31b2a2708d5c9074074c578d3c521bd4385875e500f274fce52d3074460aa",
    "sender": "0x3b6d02a24df681ffdf621d35d70aba7adaac07c1",
    "receiver": "0x3b6d02a24df681ffdf621d35d70aba7adaac07c1",
    "token": {
      "address": {
        "l1": "0xc98d64da73a6616c42117b582e832812e7b8d57f",
        "l2": "0x4200000000000000000000000000000000000042"
      },
      "value": "10000000000000000000000"
    },
    "event": {
      "deposit": {
        "initialized": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        },
        "finalized": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        }
      },
      "withdraw": {
        "initialized": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        },
        "proved": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        },
        "finalized": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        }
      }
    }
  }
}
GET
/nta/stakings/transactions

Retrieve staking transactions

Retrieve a list of staking transactions based on various query parameters such as cursor, staker, node, transaction type, pending status, and limit. This endpoint allows users to filter transactions to get precise data related to staking activities including deposits, withdrawals, stakes, and unstakes. The response includes detailed transaction information such as staker address, Node address, value staked, associated chips, and related events. Use this endpoint for monitoring, auditing, or analyzing staking transactions. The 'cursor' parameter can be used for pagination to fetch subsequent sets of results.

/nta/stakings/transactions

Query Parameters

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

stakerstring

Staker address

nodestring

Node address

typestring

Type of staking transaction

Value in: "deposit" | "withdraw" | "stake" | "unstake" | "merge_chips"

pendingboolean

Pending status of the transaction

limitinteger

Limit the number of results

Default: 50
curl -X GET "https://gi.rss3.io/nta/stakings/transactions?cursor=string&staker=string&node=string&type=deposit&pending=true&limit=50"

List of staking transactions retrieved successfully with pagination cursor

{
  "data": [
    {
      "id": "0xcb4038576ed46c3913915435c7ccb7316cf83c626dfcf580d0b84b86702e76eb",
      "staker": "0xc8b960d09c0078c18dcbe7eb9ab9d816bcca8944",
      "node": "0x08d66b34054a174841e2361bd4746ff9f4905cc2",
      "value": "5000000000000000000000",
      "chip_ids": [
        1690,
        1691
      ],
      "event": {
        "deposit": {
          "deposited": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          }
        },
        "withdraw": {
          "requested": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          },
          "claimed": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          }
        },
        "stake": {
          "staked": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          }
        },
        "unstake": {
          "requested": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          },
          "claimed": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          }
        },
        "merge_chips": {
          "merged": {
            "block": {
              "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
              "number": 726419,
              "timestamp": 1708337158
            },
            "transaction": {
              "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
              "index": 1
            }
          }
        }
      }
    }
  ],
  "cursor": "string"
}
GET
/nta/stakings/transactions/{transaction_hash}

Retrieve staking transaction by hash

Retrieve staking transaction details by its transaction hash. This endpoint provides comprehensive data about a single staking transaction, including staker address, Node address, value staked, associated chips, and related events.

/nta/stakings/transactions/{transaction_hash}

Path Parameters

transaction_hash
Required
string

The unique hash of the staking transaction

curl -X GET "https://gi.rss3.io/nta/stakings/transactions/string"

Staking transaction details fetched successfully

{
  "data": {
    "id": "0xcb4038576ed46c3913915435c7ccb7316cf83c626dfcf580d0b84b86702e76eb",
    "staker": "0xc8b960d09c0078c18dcbe7eb9ab9d816bcca8944",
    "node": "0x08d66b34054a174841e2361bd4746ff9f4905cc2",
    "value": "5000000000000000000000",
    "chip_ids": [
      1690,
      1691
    ],
    "event": {
      "deposit": {
        "deposited": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        }
      },
      "withdraw": {
        "requested": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        },
        "claimed": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        }
      },
      "stake": {
        "staked": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        }
      },
      "unstake": {
        "requested": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        },
        "claimed": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        }
      },
      "merge_chips": {
        "merged": {
          "block": {
            "hash": "0x200b26e118e51f23d052ef3aa92bc411dbd0a6ce811f511adb9f6049dc938614",
            "number": 726419,
            "timestamp": 1708337158
          },
          "transaction": {
            "hash": "0x6595192f1193c2584c28e7d4b50b9208242bf9b4538933f0081d3f4625373d2f",
            "index": 1
          }
        }
      }
    }
  }
}
GET
/nta/stakings/stakings

Retrieve a list of stakers and Nodes

Retrieve a list of stakers and their associated Nodes. This endpoint allows users to filter the results by staker address, Node address, and to paginate through the results using cursor and limit parameters. The response includes detailed information about each staker, node, and associated chips.

/nta/stakings/stakings

Query Parameters

staker_addressstring

Staker address

node_addressstring

Node address

limitinteger

Limit the number of results

Default: 50

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

curl -X GET "https://gi.rss3.io/nta/stakings/stakings?staker_address=string&node_address=string&limit=50&cursor=string"

A successful response containing a list of stakers and their associated nodes. Each entry in the data array represents a staker and includes detailed information about the staker, the Node they are associated with, and any associated chips. The response also includes a cursor for pagination to fetch subsequent sets of results. This allows users to retrieve large datasets incrementally.

{
  "data": [
    {
      "staker": "0x3b6d02a24df681ffdf621d35d70aba7adaac07c1",
      "node": "0x08d66b34054a174841e2361bd4746ff9f4905cc2",
      "chips": {
        "total": 0,
        "showcase": [
          {
            "id": 1690,
            "node": "0x08d66b34054a174841e2361bd4746ff9f4905cc2",
            "owner": "0xc8b960d09c0078c18dcbe7eb9ab9d816bcca8944",
            "metadata": {
              "name": "Open Chips #1690",
              "description": "Chip Monsters are unique creatures living in the RSS3 Network, each one special because of where it was born. They represent the idea of FREE and OPEN INFORMATION, thriving in a world that values sharing and being different. These Chip Monsters are more than just digital; they symbolize the excitement and importance of being unique in a connected digital world.",
              "image": "https://gi.rss3.io/nta/chips/1690/image.svg"
            },
            "value": "500000000000000000000",
            "latest_value": "613891695796128425340"
          }
        ]
      }
    }
  ],
  "cursor": "0xc7d6378960bd3374c31ce6223df0e79355ff3dc4b6dccf28afe84487321ef9fb"
}
GET
/nta/stakings/{staker_address}/profit

Retrieve staking profit of a staker

Retrieve the staking profit information for a specified staker. This endpoint returns detailed profit data, including the owner's address, total chip amount, total chip value, and profit and loss (PNL) data over different time periods (one day, one week, one month).

/nta/stakings/{staker_address}/profit

Path Parameters

staker_address
Required
string

The address of the staker whose profit information is to be retrieved.

curl -X GET "https://gi.rss3.io/nta/stakings/string/profit"

A successful response containing the staking profit information for the specified staker. The data includes the owner's address, total chip amount, total chip value, and profit and loss (PNL) data for one day, one week, and one month.

{
  "data": {
    "owner": "0x827431510a5d249ce4fdb7f00c83a3353f471848",
    "total_chip_amount": "1000",
    "total_chip_value": "100000",
    "oneDay": {
      "date": "2024-06-14T01:57:07Z",
      "total_chip_amount": "24",
      "total_chip_value": "14459771035071565497880",
      "profit_and_loss": "0.0066375630868202"
    },
    "oneWeek": {
      "date": "2024-06-14T01:57:07Z",
      "total_chip_amount": "24",
      "total_chip_value": "14459771035071565497880",
      "profit_and_loss": "0.0066375630868202"
    },
    "oneMonth": {
      "date": "2024-06-14T01:57:07Z",
      "total_chip_amount": "24",
      "total_chip_value": "14459771035071565497880",
      "profit_and_loss": "0.0066375630868202"
    }
  }
}
GET
/nta/stakings/{staker_address}/stat

Retrieve the number of nodes, chips, and tokens staked of a staker

Retrieve the number of nodes, chips, and tokens staked by a specific staker. This endpoint returns detailed information about the staker, including the number of nodes staked, number of chips owned, total tokens staked, and the total value of the staker's assets.

/nta/stakings/{staker_address}/stat

Path Parameters

staker_address
Required
string

The address of the staker whose profit information is to be retrieved.

curl -X GET "https://gi.rss3.io/nta/stakings/string/stat"

A successful response containing detailed information about the specified staker. The data includes the staker's wallet address, total staked nodes, total chips, total staked tokens, and current staked tokens.

{
  "data": {
    "address": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
    "total_staked_nodes": 1,
    "total_chips": "374",
    "total_staked_tokens": "199547980194376366760196",
    "current_staked_tokens": "199547980194376366760196"
  }
}
GET
/nta/chips

Retrieve all chips

Retrieve a list of all chips. This endpoint allows users to filter the results by cursor, chip IDs, Node address, owner address, and to paginate through the results using cursor and limit parameters. The response includes detailed information about each chip and a cursor for pagination to fetch subsequent sets of results.

/nta/chips

Query Parameters

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

idarray<integer>

Array of chip IDs to filter the results.

nodestring

Node address

ownerstring

The address of the chip owner to filter the results.

limitinteger

Limit the number of results

Default: 200
curl -X GET "https://gi.rss3.io/nta/chips?cursor=string&id=%5B%0A++0%0A%5D&node=string&owner=string&limit=200"

A successful response containing a list of chips based on the provided filters. Each chip includes detailed information such as its ID, Node address, owner address, and metadata. The response also includes a cursor for pagination to fetch subsequent sets of results.

{
  "data": [
    {
      "id": 1690,
      "node": "0x08d66b34054a174841e2361bd4746ff9f4905cc2",
      "owner": "0xc8b960d09c0078c18dcbe7eb9ab9d816bcca8944",
      "metadata": {
        "name": "Open Chips #1690",
        "description": "Chip Monsters are unique creatures living in the RSS3 Network, each one special because of where it was born. They represent the idea of FREE and OPEN INFORMATION, thriving in a world that values sharing and being different. These Chip Monsters are more than just digital; they symbolize the excitement and importance of being unique in a connected digital world.",
        "image": "https://gi.rss3.io/nta/chips/1690/image.svg"
      },
      "value": "500000000000000000000",
      "latest_value": "613891695796128425340"
    }
  ],
  "cursor": "0x08d66b34054a174841e2361bd4746ff9f4905cc2"
}
GET
/nta/chips/{chip_id}

Retrieve Chips by chip id

Retrieve chip details using its unique ID. This endpoint returns comprehensive data about the chip, including its Node address, owner address, and metadata such as name, description, and image.

/nta/chips/{chip_id}

Path Parameters

chip_id
Required
integer

The unique identifier of the chip to retrieve.

curl -X GET "https://gi.rss3.io/nta/chips/0"

A successful response containing detailed information about the specified chip. The data includes the chip's ID, Node address, owner address, and metadata such as name, description, and image.

{
  "id": 1690,
  "node": "0x08d66b34054a174841e2361bd4746ff9f4905cc2",
  "owner": "0xc8b960d09c0078c18dcbe7eb9ab9d816bcca8944",
  "metadata": {
    "name": "Open Chips #1690",
    "description": "Chip Monsters are unique creatures living in the RSS3 Network, each one special because of where it was born. They represent the idea of FREE and OPEN INFORMATION, thriving in a world that values sharing and being different. These Chip Monsters are more than just digital; they symbolize the excitement and importance of being unique in a connected digital world.",
    "image": "https://gi.rss3.io/nta/chips/1690/image.svg"
  },
  "value": "500000000000000000000",
  "latest_value": "613891695796128425340"
}
GET
/nta/chips/{chip_id}/image.svg

Retrieve Chips image by id

Retrieve the image of a specific chip by its unique chip ID. This endpoint returns the SVG image associated with the chip.

/nta/chips/{chip_id}/image.svg

Path Parameters

chip_id
Required
integer

The unique identifier of the chip to retrieve.

curl -X GET "https://gi.rss3.io/nta/chips/0/image.svg"

A successful response containing the SVG image of the specified chip. The image can be used to visually represent the chip.

"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n  <svg version=\"1.1\" id=\"Layer_1\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" x=\"0px\" y=\"0px\" viewBox=\"0 0 100 100\" style=\"enable-background:new 0 0 100 100;background-color:black;\" xml:space=\"preserve\">\n    <style type=\"text/css\">.f{fill:#FB1467;}.c{fill:#1477FB;}.b{fill:#DEE5D9;}.h{fill:#DEE5D9;}.alpha{fill:#1477FB;}.pg{fill:#FB1467;}.e{fill-rule:evenodd;clip-rule:evenodd;}</style>\n    <path class=\"f\" d=\"M16 88h68v2H16zm0 4h4v2h-4zm6 0h2v2h-2zm4 0h6v2h-6zm12 0h6v2h-6zm8 0h3v2h-3zm5 0h3v2h-3zm-17 0h2v2h-2zm22 0h6v2h-6zm8 0h2v2h-2zm4 0h6v2h-6zm12 0h4v2h-4zm-4 0h2v2h-2zM16 10h68v2H16zm0-4h4v2h-4zm6 0h2v2h-2zm4 0h6v2h-6zm12 0h6v2h-6zm8 0h3v2h-3zm5 0h3v2h-3zM34 6h2v2h-2zm22 0h6v2h-6zm8 0h2v2h-2zm4 0h6v2h-6zm12 0h4v2h-4zm-4 0h2v2h-2zM12 16v68h-2V16zM6 84v-4h2v4zm0-6v-2h2v2zm0-4v-6h2v6zm0-12v-6h2v6zm0-8v-3h2v3zm0-5v-3h2v3zm0 17v-2h2v2zm0-22v-6h2v6zm0-8v-2h2v2zm0-4v-6h2v6zm0-12v-4h2v4zm0 4v-2h2v2zm84-8v68h-2V16zm2 68v-4h2v4zm0-6v-2h2v2zm0-4v-6h2v6zm0-12v-6h2v6zm0-8v-3h2v3zm0-5v-3h2v3zm0 17v-2h2v2zm0-22v-6h2v6zm0-8v-2h2v2zm0-4v-6h2v6zm0-12v-4h2v4zm0 4v-2h2v2z\"/>\n    <svg class=\"c\">\n      <path d=\"M52 80h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M58 84v2h-6v-2zm0-4v2h-6v-2zm10 0h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M74 84v2h-6v-2zm0-4v2h-6v-2zm6-12h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M86 72v2h-6v-2zm0-4v2h-6v-2zm-6 12h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M86 84v2h-6v-2zm0-4v2h-6v-2zm-6-28h6v6h-6zM54 86h2v2h-2zm4-2v-2h10v2zm16-6h2v2h-2zm-24 4h2v2h-2zm26-6h2v2h-2zm2-2h2v2h-2zm-4 8h6v2h-6zm6-40h6v6h-6zm4 32v6h-2v-6zm0-16v10h-2V58zm0-26v10h-2V32zm-2 16h2v4h-2zM52 20h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M58 16v-2h-6v2zm0 4v-2h-6v2zm10 0h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M74 16v-2h-6v2zm0 4v-2h-6v2zm6 12h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M86 28v-2h-6v2zm0 4v-2h-6v2zm-6-12h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M86 16v-2h-6v2zm0 4v-2h-6v2zm-32-6h2v-2h-2zm4 2v2h10v-2zm16 6h2v-2h-2zm-24-4h2v-2h-2zm26 6h2v-2h-2zm2 2h2v-2h-2zm-4-8h6v-2h-6zm10 8v-6h-2v6zm-36-6h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M42 16v-2h6v2zm0 4v-2h6v2zm-10 0h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M26 16v-2h6v2zm0 4v-2h6v2zm-6 12h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M14 28v-2h6v2zm0 4v-2h6v2zm6-12h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M14 16v-2h6v2zm0 4v-2h6v2zm6 28h-6v-6h6zm26-34h-2v-2h2zm-4 2v2H32v-2zm-16 6h-2v-2h2zm24-4h-2v-2h2zm-26 6h-2v-2h2zm-2 2h-2v-2h2zm4-8h-6v-2h6zm-6 40h-6v-6h6zm-4-32v-6h2v6zm0 16V32h2v10zm0 26V58h2v10zm2-16h-2v-4h2zm30 28h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M42 84v2h6v-2zm0-4v2h6v-2zm-10 0h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M26 84v2h6v-2zm0-4v2h6v-2zm-6-12h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M14 72v2h6v-2zm0-4v2h6v-2zm6 12h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M14 84v2h6v-2zm0-4v2h6v-2zm32 6h-2v2h2zm-4-2v-2H32v2zm-16-6h-2v2h2zm24 4h-2v2h2zm-26-6h-2v2h2zm-2-2h-2v2h2zm4 8h-6v2h6zm-10-8v6h2v-6z\"/>\n    </svg>\n    <path class=\"alpha\" d=\"M6 6V4h4v2zm4 0v2H6V6H4v6h2v-2h4v2h2V6zm84-2v2h-4V4zm0 2v2h-4V6h-2v6h2v-2h4v2h2V6zM10 88v2H6v-2zm0 2v2H6v-2H4v6h2v-2h4v2h2v-6zm84-2v2h-4v-2zm0 2v2h-4v-2h-2v6h2v-2h4v2h2v-6z\"/>\n    <polygon class=\"b\" points=\"72,46 72,64 70,64 70,66 68,66 68,68 66,68 66,70 64,70 64,72 36,72 36,70 34,70 34,68 32,68 32,66   30,66 30,64 28,64 28,46 30,46 30,44 70,44 70,46 \"/>\n    <path d=\"M36 50h2v2h-2zm2 2h2v2h-2zm2 2h2v2h-2zm-4 0h2v2h-2zm4-4h2v2h-2zm18 0h2v2h-2zm2 2h2v2h-2zm2 2h2v2h-2zm-4 0h2v2h-2zm4-4h2v2h-2zm-14 6h4v2h-4zm-2-2h2v2h-2zm6 0h2v2h-2z\" fill=\"#000\"/>\n    <path d=\"M40 62h2v2h-2zM42 64h2v2h-2zM42 62h2v2h-2zM44 64h2v2h-2z\" fill=\"#000\"/>\n    <path d=\"M44 64h16v4H44z\" fill=\"#000\"/>\n    <path class=\"h\" d=\"M28 40h44v2H28z\"/>\n    <path class=\"h e\" d=\"M40 33v-3h-2v-2h-2v2h-2v2h-2v2h-2v2h-2v2h5v-2h2v2h5v-3h-4v-2z\"/>\n    <path class=\"h e\" d=\"M42 24v2h-4v2h4v2h5v2h-5v6h7V24zm5 4h-2v-2h2zm23 8v-2h-2v-2h-2v-2h-2v-2h-2v2h-2v3h4v2h-6v-3h-3v6h10v-2h2v2h5v-2z\"/>\n    <path class=\"h e\" d=\"M58 26v-2h-7v14h2v-8h5v-2h4v-2zm-3 2h-2v-2h2z\"/>\n  </svg>"
GET
/nta/snapshots/nodes/count

Retrieve snapshots of Node count

Retrieve snapshots of the Node count over time. This endpoint returns an array of objects, each containing the date and the corresponding count of nodes on that date.

/nta/snapshots/nodes/count
curl -X GET "https://gi.rss3.io/nta/snapshots/nodes/count"

A successful response containing snapshots of Node counts over time. Each entry in the data array includes the date and the count of nodes on that date.

{
  "data": [
    {
      "date": "2024-03-10",
      "count": 1
    }
  ]
}
GET
/nta/snapshots/stakers/count

Retrieve snapshots of staker count

Retrieve snapshots of the total staker count over time. This endpoint returns an array of objects, each containing the date and the corresponding count of stakers on that date.

/nta/snapshots/stakers/count
curl -X GET "https://gi.rss3.io/nta/snapshots/stakers/count"

A successful response containing snapshots of the total staker count over time. Each entry in the data array includes the date and the count of stakers on that date.

{
  "data": [
    {
      "date": "2024-03-10",
      "count": 1
    }
  ]
}
GET
/nta/snapshots/stakers/profit

Retrieve snapshots of the staker profit

Retrieve snapshots of the staker profit over time. This endpoint allows filtering by staker address, date range, and pagination parameters.

/nta/snapshots/stakers/profit

Query Parameters

staker_addressstring

Staker address

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

limitinteger

Limit the number of results

Default: 50

beforeDatestring

The date before which the snapshots are returned.

Format: "date"

afterDatestring

The date after which the snapshots are returned.

Format: "date"
curl -X GET "https://gi.rss3.io/nta/snapshots/stakers/profit?staker_address=string&cursor=string&limit=50&beforeDate=2019-08-24&afterDate=2019-08-24"

A successful response containing snapshots of the staker profit over time. Each entry in the data array includes the date and profit details. The response also includes a cursor for pagination to fetch subsequent sets of results.

{
  "data": [
    {
      "address": "0xc8b960d09c0078c18dcbe7eb9ab9d816bcca8944",
      "date": "2024-06-17T02:01:29Z",
      "epoch_id": 1,
      "total_chip_amount": "24",
      "total_chip_value": "14459771035071565497880"
    }
  ],
  "cursor": "string"
}
GET
/nta/snapshots/nodes/operation/profit

Retrieve snapshots of operation profit

Retrieve snapshots of the operation profit over time for a specific node. This endpoint allows filtering by Node address, date range, and pagination parameters.

/nta/snapshots/nodes/operation/profit

Query Parameters

node_addressstring

Node address

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

limitinteger

Limit the number of results

Default: 50

beforeDatestring

The date before which the snapshots are returned.

Format: "date"

afterDatestring

The date after which the snapshots are returned.

Format: "date"
curl -X GET "https://gi.rss3.io/nta/snapshots/nodes/operation/profit?node_address=string&cursor=string&limit=50&beforeDate=2019-08-24&afterDate=2019-08-24"

A successful response containing snapshots of the operation profit over time for the specified node. Each entry in the data array includes the date and profit details. The response also includes a cursor for pagination to fetch subsequent sets of results.

{
  "data": [
    {
      "address": "string",
      "date": "2024-03-13T00:08:38+08:00",
      "epoch_id": 0,
      "operation_pool": "string"
    }
  ],
  "cursor": "string"
}
GET
/nta/snapshots/epochs/apy

Retrieve snapshots of epoch APY.

Retrieve the Annual Percentage Yield (APY) for epoch snapshots. This endpoint returns an array of objects, each containing an epoch ID and the corresponding APY.

/nta/snapshots/epochs/apy
curl -X GET "https://gi.rss3.io/nta/snapshots/epochs/apy"

A successful response containing the APY for epoch snapshots. Each entry in the data array includes the epoch details and the corresponding APY.

{
  "data": [
    {
      "date": "2024-06-17T20:02:35Z",
      "epoch_id": 1,
      "apy": "0.1"
    }
  ]
}
GET
/nta/nodes

Retrieve all RSS3 Nodes

Retrieve the list of all RSS3 Nodes. This endpoint allows filtering by cursor, limit, and Node address.

/nta/nodes

Query Parameters

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

limitinteger

Limit the number of results

Default: 50

nodestring

Node address

curl -X GET "https://gi.rss3.io/nta/nodes?cursor=string&limit=50&node=string"

A successful response containing a list of nodes. Each entry includes detailed information about the node.

[
  {
    "id": 18,
    "address": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
    "name": "Natural Selection Labs",
    "description": "A Node operated by NSL.",
    "tax_rate_basis_points": 800,
    "is_public_good": false,
    "operation_pool_tokens": "724429065703690345869831",
    "staking_pool_tokens": "20798363499373370863570687",
    "total_shares": "17339500000000000000000000",
    "slashed_tokens": "0",
    "alpha": true,
    "status": "online",
    "last_heartbeat": 1718694464,
    "location": [
      {
        "country": "United States",
        "region": "",
        "city": "",
        "latitude": 37.751,
        "longitude": -97.822
      }
    ],
    "avatar": {
      "name": "Node Avatar",
      "description": "",
      "image": "https://gi.rss3.io/nta/nodes/0x69982E017Acc0FDE3d1542205089A8d3EAfcD1B7/avatar.svg"
    },
    "min_tokens_to_stake": "599739424417467944968",
    "apy": "0.3928765550642588002426864199264",
    "reliability_score": "0",
    "version": "v1.0.0",
    "type": "production",
    "created_at": 1710278898
  }
]
GET
/nta/nodes/{address}

Retrieve Node by address

Retrieve Node details by its address.

/nta/nodes/{address}

Path Parameters

address
Required
string

The address of the Node to retrieve.

curl -X GET "https://gi.rss3.io/nta/nodes/string"

A successful response containing detailed information about the specified node.

{
  "id": 18,
  "address": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
  "name": "Natural Selection Labs",
  "description": "A Node operated by NSL.",
  "tax_rate_basis_points": 800,
  "is_public_good": false,
  "operation_pool_tokens": "724429065703690345869831",
  "staking_pool_tokens": "20798363499373370863570687",
  "total_shares": "17339500000000000000000000",
  "slashed_tokens": "0",
  "alpha": true,
  "status": "online",
  "last_heartbeat": 1718694464,
  "location": [
    {
      "country": "United States",
      "region": "",
      "city": "",
      "latitude": 37.751,
      "longitude": -97.822
    }
  ],
  "avatar": {
    "name": "Node Avatar",
    "description": "",
    "image": "https://gi.rss3.io/nta/nodes/0x69982E017Acc0FDE3d1542205089A8d3EAfcD1B7/avatar.svg"
  },
  "min_tokens_to_stake": "599739424417467944968",
  "apy": "0.3928765550642588002426864199264",
  "reliability_score": "0",
  "version": "v1.0.0",
  "type": "production",
  "created_at": 1710278898
}
GET
/nta/nodes/{address}/avatar.svg

Retrieve Node avatar by address

Retrieve the avatar of a specific Node by its address. This endpoint returns the SVG image associated with the node.

/nta/nodes/{address}/avatar.svg

Path Parameters

address
Required
string

The address of the Node to retrieve.

curl -X GET "https://gi.rss3.io/nta/nodes/string/avatar.svg"

A successful response containing the SVG image of the specified node. The image can be used to visually represent the node.

"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n  <svg version=\"1.1\" id=\"Layer_1\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" x=\"0px\" y=\"0px\" viewBox=\"0 0 100 100\" style=\"enable-background:new 0 0 100 100;background-color:black;\" xml:space=\"preserve\">\n    <style type=\"text/css\">.f{fill:#FB1467;}.c{fill:#1477FB;}.b{fill:#DEE5D9;}.h{fill:#DEE5D9;}.alpha{fill:#1477FB;}.pg{fill:#FB1467;}.e{fill-rule:evenodd;clip-rule:evenodd;}</style>\n    <path class=\"f\" d=\"M16 88h68v2H16zm0 4h4v2h-4zm6 0h2v2h-2zm4 0h6v2h-6zm12 0h6v2h-6zm8 0h3v2h-3zm5 0h3v2h-3zm-17 0h2v2h-2zm22 0h6v2h-6zm8 0h2v2h-2zm4 0h6v2h-6zm12 0h4v2h-4zm-4 0h2v2h-2zM16 10h68v2H16zm0-4h4v2h-4zm6 0h2v2h-2zm4 0h6v2h-6zm12 0h6v2h-6zm8 0h3v2h-3zm5 0h3v2h-3zM34 6h2v2h-2zm22 0h6v2h-6zm8 0h2v2h-2zm4 0h6v2h-6zm12 0h4v2h-4zm-4 0h2v2h-2zM12 16v68h-2V16zM6 84v-4h2v4zm0-6v-2h2v2zm0-4v-6h2v6zm0-12v-6h2v6zm0-8v-3h2v3zm0-5v-3h2v3zm0 17v-2h2v2zm0-22v-6h2v6zm0-8v-2h2v2zm0-4v-6h2v6zm0-12v-4h2v4zm0 4v-2h2v2zm84-8v68h-2V16zm2 68v-4h2v4zm0-6v-2h2v2zm0-4v-6h2v6zm0-12v-6h2v6zm0-8v-3h2v3zm0-5v-3h2v3zm0 17v-2h2v2zm0-22v-6h2v6zm0-8v-2h2v2zm0-4v-6h2v6zm0-12v-4h2v4zm0 4v-2h2v2z\"/>\n    <svg class=\"c\">\n      <path d=\"M52 80h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M58 84v2h-6v-2zm0-4v2h-6v-2zm10 0h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M74 84v2h-6v-2zm0-4v2h-6v-2zm6-12h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M86 72v2h-6v-2zm0-4v2h-6v-2zm-6 12h2v6h-2zm4 0h2v6h-2z\"/>\n      <path d=\"M86 84v2h-6v-2zm0-4v2h-6v-2zm-6-28h6v6h-6zM54 86h2v2h-2zm4-2v-2h10v2zm16-6h2v2h-2zm-24 4h2v2h-2zm26-6h2v2h-2zm2-2h2v2h-2zm-4 8h6v2h-6zm6-40h6v6h-6zm4 32v6h-2v-6zm0-16v10h-2V58zm0-26v10h-2V32zm-2 16h2v4h-2zM52 20h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M58 16v-2h-6v2zm0 4v-2h-6v2zm10 0h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M74 16v-2h-6v2zm0 4v-2h-6v2zm6 12h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M86 28v-2h-6v2zm0 4v-2h-6v2zm-6-12h2v-6h-2zm4 0h2v-6h-2z\"/>\n      <path d=\"M86 16v-2h-6v2zm0 4v-2h-6v2zm-32-6h2v-2h-2zm4 2v2h10v-2zm16 6h2v-2h-2zm-24-4h2v-2h-2zm26 6h2v-2h-2zm2 2h2v-2h-2zm-4-8h6v-2h-6zm10 8v-6h-2v6zm-36-6h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M42 16v-2h6v2zm0 4v-2h6v2zm-10 0h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M26 16v-2h6v2zm0 4v-2h6v2zm-6 12h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M14 28v-2h6v2zm0 4v-2h6v2zm6-12h-2v-6h2zm-4 0h-2v-6h2z\"/>\n      <path d=\"M14 16v-2h6v2zm0 4v-2h6v2zm6 28h-6v-6h6zm26-34h-2v-2h2zm-4 2v2H32v-2zm-16 6h-2v-2h2zm24-4h-2v-2h2zm-26 6h-2v-2h2zm-2 2h-2v-2h2zm4-8h-6v-2h6zm-6 40h-6v-6h6zm-4-32v-6h2v6zm0 16V32h2v10zm0 26V58h2v10zm2-16h-2v-4h2zm30 28h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M42 84v2h6v-2zm0-4v2h6v-2zm-10 0h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M26 84v2h6v-2zm0-4v2h6v-2zm-6-12h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M14 72v2h6v-2zm0-4v2h6v-2zm6 12h-2v6h2zm-4 0h-2v6h2z\"/>\n      <path d=\"M14 84v2h6v-2zm0-4v2h6v-2zm32 6h-2v2h2zm-4-2v-2H32v2zm-16-6h-2v2h2zm24 4h-2v2h2zm-26-6h-2v2h2zm-2-2h-2v2h2zm4 8h-6v2h6zm-10-8v6h2v-6z\"/>\n    </svg>\n    <path class=\"alpha\" d=\"M6 6V4h4v2zm4 0v2H6V6H4v6h2v-2h4v2h2V6zm84-2v2h-4V4zm0 2v2h-4V6h-2v6h2v-2h4v2h2V6zM10 88v2H6v-2zm0 2v2H6v-2H4v6h2v-2h4v2h2v-6zm84-2v2h-4v-2zm0 2v2h-4v-2h-2v6h2v-2h4v2h2v-6z\"/>\n    <polygon class=\"b\" points=\"72,46 72,64 70,64 70,66 68,66 68,68 66,68 66,70 64,70 64,72 36,72 36,70 34,70 34,68 32,68 32,66   30,66 30,64 28,64 28,46 30,46 30,44 70,44 70,46 \"/>\n    <path d=\"M36 50h2v2h-2zm2 2h2v2h-2zm2 2h2v2h-2zm-4 0h2v2h-2zm4-4h2v2h-2zm18 0h2v2h-2zm2 2h2v2h-2zm2 2h2v2h-2zm-4 0h2v2h-2zm4-4h2v2h-2zm-14 6h4v2h-4zm-2-2h2v2h-2zm6 0h2v2h-2z\" fill=\"#000\"/>\n    <path d=\"M40 62h2v2h-2zM42 64h2v2h-2zM42 62h2v2h-2zM44 64h2v2h-2z\" fill=\"#000\"/>\n    <path d=\"M44 64h16v4H44z\" fill=\"#000\"/>\n    <path class=\"h\" d=\"M28 40h44v2H28z\"/>\n    <path class=\"h e\" d=\"M40 33v-3h-2v-2h-2v2h-2v2h-2v2h-2v2h-2v2h5v-2h2v2h5v-3h-4v-2z\"/>\n    <path class=\"h e\" d=\"M42 24v2h-4v2h4v2h5v2h-5v6h7V24zm5 4h-2v-2h2zm23 8v-2h-2v-2h-2v-2h-2v-2h-2v2h-2v3h4v2h-6v-3h-3v6h10v-2h2v2h5v-2z\"/>\n    <path class=\"h e\" d=\"M58 26v-2h-7v14h2v-8h5v-2h4v-2zm-3 2h-2v-2h2z\"/>\n  </svg>"
GET
/nta/nodes/{address}/events

Retrieve Node transaction events by address

Retrieve the transaction events for a specific Node by its address. This endpoint allows filtering by cursor and limit for pagination.

/nta/nodes/{address}/events

Path Parameters

address
Required
string

The address of the Node to retrieve.

Query Parameters

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

limitinteger

Limit the number of results

Default: 50
curl -X GET "https://gi.rss3.io/nta/nodes/string/events?cursor=string&limit=50"

A successful response containing transaction events for the specified node. Each entry in the data array includes detailed information about the event.

{
  "data": [
    {
      "transaction": {
        "hash": "0x84c045a41d6fb83a94f4f2096863faced7c5799bcd382bec49333d017f744c41",
        "index": 1
      },
      "block": {
        "hash": "0x0e9f8868b1fd7aa28183292d198b4375263fbc38541d51efd90aec1de7e4b5bc",
        "number": 210189,
        "timestamp": 1710278897
      },
      "address_from": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
      "address_to": "0x28f14d917fddba0c1f2923c406952478dfda5578",
      "node_id": 18,
      "type": "nodeCreated",
      "log_index": 0,
      "chain_id": 12553,
      "metadata": {}
    }
  ],
  "cursor": "string"
}
GET
/nta/nodes/{address}/operation/profit

Retrieve Node operation profit by address

Retrieve the operation profit details for a specific Node by its address. This endpoint provides detailed profit and loss (PNL) information over different time periods.

/nta/nodes/{address}/operation/profit

Path Parameters

address
Required
string

The address of the Node to retrieve.

curl -X GET "https://gi.rss3.io/nta/nodes/string/operation/profit"

A successful response containing detailed information about the operation profit of the specified node. Each entry includes address, operation pool, and PNL details for different time periods.

{
  "data": {
    "node_address": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
    "operation_pool": "724429065703690345869831",
    "oneDay": {
      "date": "2024-06-17T20:02:35Z",
      "operation_pool": "724429065703690345869831",
      "profit_and_loss": "0"
    },
    "oneWeek": {
      "date": "2024-06-17T20:02:35Z",
      "operation_pool": "724429065703690345869831",
      "profit_and_loss": "0"
    },
    "oneMonth": {
      "date": "2024-06-17T20:02:35Z",
      "operation_pool": "724429065703690345869831",
      "profit_and_loss": "0"
    }
  }
}
GET
/nta/epochs

Retrieve all epochs

Retrieve a list of all epochs. This endpoint allows filtering by cursor and limit for pagination.

/nta/epochs

Query Parameters

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

limitinteger

Limit the number of results

Default: 50
curl -X GET "https://gi.rss3.io/nta/epochs?cursor=string&limit=50"

A successful response containing a list of epochs. Each entry in the data array includes brief information about the epoch.

{
  "data": [
    {
      "id": 130,
      "start_timestamp": 1718589689,
      "end_timestamp": 1718654555,
      "total_operation_rewards": "0",
      "total_staking_rewards": "61084916609459274004676",
      "total_request_counts": "40",
      "total_rewarded_nodes": 65,
      "distributions": [
        {
          "id": 130,
          "start_timestamp": 1718589689,
          "end_timestamp": 1718654555,
          "transaction": {
            "hash": "0xe804d536d996d49b0ec8627361bc642f92d440e6b519e6faab0944f70bf05fd2",
            "index": 1
          },
          "block": {
            "hash": "0xd9e2a4df54a385507a302ec3c62d3b3833ce8ed80242694d79cfa5b034840379",
            "number": 4398018,
            "timestamp": 1718654555
          },
          "total_operation_rewards": "0",
          "total_staking_rewards": "61084916609459274004676",
          "total_request_counts": "40",
          "total_rewarded_nodes": 65,
          "rewarded_nodes": [
            {
              "epoch_id": 130,
              "index": 48,
              "transaction_hash": "0xe804d536d996d49b0ec8627361bc642f92d440e6b519e6faab0944f70bf05fd2",
              "node_address": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
              "operation_rewards": "0",
              "staking_rewards": "18250125229171339678441",
              "tax_collected": "1270138765073564056898",
              "request_count": "0"
            }
          ]
        }
      ]
    }
  ],
  "cursor": "string"
}
GET
/nta/epochs/{epoch_id}

Retrieve epoch by id

Retrieve epoch details by its ID.

/nta/epochs/{epoch_id}

Path Parameters

epoch_id
Required
string

The ID of the epoch to retrieve.

curl -X GET "https://gi.rss3.io/nta/epochs/string"

A successful response containing detailed information about the specified epoch.

{
  "epoch_id": "1",
  "start_time": "2024-01-01T00:00:00Z",
  "end_time": "2024-01-07T00:00:00Z",
  "total_staked": "1000000",
  "rewards": "5000"
}
GET
/nta/epochs/distributions/{transaction_hash}

Retrieve epoch transaction by hash

Retrieve details of an epoch transaction by its hash.

/nta/epochs/distributions/{transaction_hash}

Path Parameters

transaction_hash
Required
string

The unique hash of the epoch transaction

curl -X GET "https://gi.rss3.io/nta/epochs/distributions/string"

A successful response containing details of the specified epoch transaction.

{
  "data": [
    {
      "id": 130,
      "start_timestamp": 1718589689,
      "end_timestamp": 1718654555,
      "transaction": {
        "hash": "0xe804d536d996d49b0ec8627361bc642f92d440e6b519e6faab0944f70bf05fd2",
        "index": 1
      },
      "block": {
        "hash": "0xd9e2a4df54a385507a302ec3c62d3b3833ce8ed80242694d79cfa5b034840379",
        "number": 4398018,
        "timestamp": 1718654555
      },
      "total_operation_rewards": "0",
      "total_staking_rewards": "61084916609459274004676",
      "total_request_counts": "40",
      "total_rewarded_nodes": 65,
      "rewarded_nodes": [
        {
          "epoch_id": 130,
          "index": 48,
          "transaction_hash": "0xe804d536d996d49b0ec8627361bc642f92d440e6b519e6faab0944f70bf05fd2",
          "node_address": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
          "operation_rewards": "0",
          "staking_rewards": "18250125229171339678441",
          "tax_collected": "1270138765073564056898",
          "request_count": "0"
        }
      ]
    }
  ]
}
GET
/nta/epochs/{address}/rewards

Retrieve Node rewards by epoch

Retrieve the rewards of a specific Node by epoch. This endpoint allows filtering by cursor and limit for pagination.

/nta/epochs/{address}/rewards

Path Parameters

address
Required
string

The address of the Node to retrieve.

Query Parameters

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

limitinteger

Limit the number of results

Default: 50
curl -X GET "https://gi.rss3.io/nta/epochs/string/rewards?cursor=string&limit=50"

A successful response containing the rewards of the specified Node by epoch. Each entry in the data array includes detailed information about the epoch.

{
  "data": [
    {
      "id": 130,
      "start_timestamp": 1718589689,
      "end_timestamp": 1718654555,
      "total_operation_rewards": "0",
      "total_staking_rewards": "61084916609459274004676",
      "total_request_counts": "40",
      "total_reward_items": 65,
      "distributions": [
        {
          "id": 130,
          "start_timestamp": 1718589689,
          "end_timestamp": 1718654555,
          "transaction": {
            "hash": "0xe804d536d996d49b0ec8627361bc642f92d440e6b519e6faab0944f70bf05fd2",
            "index": 1
          },
          "block": {
            "hash": "0xd9e2a4df54a385507a302ec3c62d3b3833ce8ed80242694d79cfa5b034840379",
            "number": 4398018,
            "timestamp": 1718654555
          },
          "total_operation_rewards": "0",
          "total_staking_rewards": "61084916609459274004676",
          "total_request_counts": "40",
          "total_rewarded_nodes": 65,
          "rewarded_nodes": [
            {
              "epoch_id": 130,
              "index": 48,
              "transaction_hash": "0xe804d536d996d49b0ec8627361bc642f92d440e6b519e6faab0944f70bf05fd2",
              "node_address": "0x69982e017acc0fde3d1542205089a8d3eafcd1b7",
              "operation_rewards": "0",
              "staking_rewards": "18250125229171339678441",
              "tax_collected": "1270138765073564056898",
              "request_count": "0"
            }
          ]
        }
      ]
    }
  ],
  "cursor": "string"
}
GET
/nta/epochs/apy

Retrieve the average of epochs APY

Retrieve the average Annual Percentage Yield (APY) for all epochs.

/nta/epochs/apy
curl -X GET "https://gi.rss3.io/nta/epochs/apy"

A successful response containing the average APY for all epochs.

{
  "data": "1.4665029316918649354"
}
GET
/nta/networks/assets

Retrieve Node Assets

Retrieve Node assets details.

/nta/networks/assets
curl -X GET "https://gi.rss3.io/nta/networks/assets"

A successful response containing the details of an asset (network and worker).

{
  "data": {
    "networks": {
      "arbitrum": {
        "type": "ethereum",
        "name": "Arbitrum",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/arbitrum.svg"
      },
      "arweave": {
        "type": "arweave",
        "name": "Arweave",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/arweave.svg"
      },
      "avax": {
        "type": "ethereum",
        "name": "Avalanche",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/avalanche.svg"
      },
      "base": {
        "type": "ethereum",
        "name": "Base",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/base.svg"
      },
      "binance-smart-chain": {
        "type": "ethereum",
        "name": "Binance Smart Chain",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/binance-smart-chain.svg"
      },
      "crossbell": {
        "type": "ethereum",
        "name": "Crossbell",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/crossbell.svg"
      },
      "ethereum": {
        "type": "ethereum",
        "name": "Ethereum",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/ethereum.svg"
      },
      "farcaster": {
        "type": "farcaster",
        "name": "Farcaster",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/farcaster.svg"
      },
      "gnosis": {
        "type": "ethereum",
        "name": "Gnosis",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/gnosis-chain.svg"
      },
      "linea": {
        "type": "ethereum",
        "name": "Linea",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/linea.svg"
      },
      "optimism": {
        "type": "ethereum",
        "name": "Optimism",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/optimism.svg"
      },
      "polygon": {
        "type": "ethereum",
        "name": "Polygon",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/polygon.svg"
      },
      "vsl": {
        "type": "ethereum",
        "name": "VSL",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/rss3-vsl.svg"
      },
      "x-layer": {
        "type": "ethereum",
        "name": "X Layer",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/x-layer.svg"
      }
    },
    "workers": {
      "1inch": {
        "type": "decentralized",
        "name": "1inch",
        "platform": "1inch",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/1inch.svg"
      },
      "aave": {
        "type": "decentralized",
        "name": "aave",
        "platform": "AAVE",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/aave.svg"
      },
      "aavegotchi": {
        "type": "decentralized",
        "name": "aavegotchi",
        "platform": "Aavegotchi",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/aavegotchi.svg"
      },
      "core": {
        "type": "decentralized",
        "name": "core",
        "platform": "Unknown",
        "icon_url": ""
      },
      "crossbell": {
        "type": "decentralized",
        "name": "crossbell",
        "platform": "Crossbell",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/crossbell.svg"
      },
      "curve": {
        "type": "decentralized",
        "name": "curve",
        "platform": "Curve",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/curve.svg"
      },
      "ens": {
        "type": "decentralized",
        "name": "ens",
        "platform": "ENS",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/ens.svg"
      },
      "highlight": {
        "type": "decentralized",
        "name": "highlight",
        "platform": "Highlight",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/highlight.svg"
      },
      "iqwiki": {
        "type": "decentralized",
        "name": "iqwiki",
        "platform": "IQWiki",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/iqwiki.svg"
      },
      "kiwistand": {
        "type": "decentralized",
        "name": "kiwistand",
        "platform": "KiwiStand",
        "icon_url": "https://storage.googleapis.com/rss3-icon/kiwistand.png"
      },
      "lens": {
        "type": "decentralized",
        "name": "lens",
        "platform": "Lens",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/lens.svg"
      },
      "lido": {
        "type": "decentralized",
        "name": "lido",
        "platform": "Lido",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/lido.svg"
      },
      "looksrare": {
        "type": "decentralized",
        "name": "looksrare",
        "platform": "LooksRare",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/looks-rare.svg"
      },
      "matters": {
        "type": "decentralized",
        "name": "matters",
        "platform": "Matters",
        "icon_url": "https://storage.googleapis.com/rss3-icon/matters.jpg"
      },
      "mirror": {
        "type": "decentralized",
        "name": "mirror",
        "platform": "Mirror",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/mirror.svg"
      },
      "momoka": {
        "type": "decentralized",
        "name": "momoka",
        "platform": "Lens",
        "icon_url": "https://storage.googleapis.com/rss3-icon/momoka.png"
      },
      "opensea": {
        "type": "decentralized",
        "name": "opensea",
        "platform": "OpenSea",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/opensea.svg"
      },
      "optimism": {
        "type": "decentralized",
        "name": "optimism",
        "platform": "Optimism",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/optimism.svg"
      },
      "paragraph": {
        "type": "decentralized",
        "name": "paragraph",
        "platform": "Paragraph",
        "icon_url": "https://storage.googleapis.com/rss3-icon/paragraph.png"
      },
      "rss3": {
        "type": "decentralized",
        "name": "rss3",
        "platform": "RSS3",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/rss3.svg"
      },
      "rsshub": {
        "type": "rss",
        "name": "rsshub",
        "platform": "RSSHub",
        "icon_url": "https://storage.googleapis.com/rss3-icon/rsshub.png"
      },
      "stargate": {
        "type": "decentralized",
        "name": "stargate",
        "platform": "Stargate",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/stargate.svg"
      },
      "uniswap": {
        "type": "decentralized",
        "name": "uniswap",
        "platform": "Uniswap",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/uniswap.svg"
      },
      "vsl": {
        "type": "decentralized",
        "name": "vsl",
        "platform": "VSL",
        "icon_url": "https://unpkg.com/@rss3/web3-icons-svg@latest/icons/rss3-vsl.svg"
      }
    }
  }
}
GET
/nta/networks/config

Retrieve network config

Retrieve the configuration details of RSS, Decentralized, and Federated networks.

/nta/networks/config
curl -X GET "https://gi.rss3.io/nta/networks/config"

A successful response containing the configuration details of RSS, Decentralized, and Federated networks.

{
  "data": {
    "data": {
      "rss": {
        "id": "string",
        "worker_configs": {
          "id": {
            "is_required": true,
            "type": "string",
            "value": "string",
            "description": "string",
            "title": "string",
            "key": "string"
          },
          "network": {
            "is_required": true,
            "type": "string",
            "value": "string",
            "description": "string",
            "title": "string",
            "key": "string"
          },
          "worker": {
            "is_required": true,
            "type": "string",
            "value": "string",
            "description": "string",
            "title": "string",
            "key": "string"
          },
          "endpoint": {
            "is_required": true,
            "type": "string",
            "value": "string",
            "description": "string",
            "title": "string",
            "key": "string"
          },
          "parameters": {
            "authentication": {
              "access_key": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              }
            }
          },
          "minimum_resource": {
            "cpu_core": 0,
            "memory_in_gb": 0,
            "disk_space_in_gb": 0,
            "title": "string",
            "key": "string"
          }
        }
      },
      "decentralized": [
        {
          "id": "string",
          "endpoint_configs": {
            "url": {
              "is_required": true,
              "type": "string",
              "value": "string",
              "description": "string",
              "title": "string",
              "key": "string"
            },
            "http_headers": {
              "is_required": true,
              "type": "string",
              "value": "string",
              "description": "string",
              "title": "string",
              "key": "string"
            },
            "http2_disabled": {
              "is_required": true,
              "type": "string",
              "value": "string",
              "description": "string",
              "title": "string",
              "key": "string"
            }
          },
          "worker_configs": [
            {
              "id": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "network": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "worker": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "endpoint": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "parameters": {
                "concurrent_block_requests": {
                  "is_required": true,
                  "type": "string",
                  "value": "string",
                  "description": "string",
                  "title": "string",
                  "key": "string"
                },
                "block_batch_size": {
                  "is_required": true,
                  "type": "string",
                  "value": "string",
                  "description": "string",
                  "title": "string",
                  "key": "string"
                },
                "receipts_batch_size": {
                  "is_required": true,
                  "type": "string",
                  "value": "string",
                  "description": "string",
                  "title": "string",
                  "key": "string"
                },
                "block_receipts_batch_size": {
                  "is_required": true,
                  "type": "string",
                  "value": "string",
                  "description": "string",
                  "title": "string",
                  "key": "string"
                }
              },
              "minimum_resource": {
                "cpu_core": 0,
                "memory_in_gb": 0,
                "disk_space_in_gb": 0,
                "title": "string",
                "key": "string"
              }
            }
          ]
        }
      ],
      "federated": [
        {
          "id": "string",
          "endpoint_configs": {
            "url": {
              "is_required": true,
              "type": "string",
              "value": "string",
              "description": "string",
              "title": "string",
              "key": "string"
            },
            "http_headers": {
              "is_required": true,
              "type": "string",
              "value": "string",
              "description": "string",
              "title": "string",
              "key": "string"
            },
            "http2_disabled": {
              "is_required": true,
              "type": "string",
              "value": "string",
              "description": "string",
              "title": "string",
              "key": "string"
            }
          },
          "worker_configs": [
            {
              "id": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "network": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "worker": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "endpoint": {
                "is_required": true,
                "type": "string",
                "value": "string",
                "description": "string",
                "title": "string",
                "key": "string"
              },
              "parameters": {
                "kafka_topic": {
                  "is_required": true,
                  "type": "string",
                  "value": "string",
                  "description": "string",
                  "title": "string",
                  "key": "string"
                }
              },
              "minimum_resource": {
                "cpu_core": 0,
                "memory_in_gb": 0,
                "disk_space_in_gb": 0,
                "title": "string",
                "key": "string"
              }
            }
          ]
        }
      ]
    }
  }
}
GET
/nta/dsl/total_requests

Retrieve DSL total requests

Retrieve the total number of requests served by Global Indexers.

/nta/dsl/total_requests
curl -X GET "https://gi.rss3.io/nta/dsl/total_requests"

A successful response containing the total number of requests made to the API.

{
  "data": {
    "total_requests": 0
  }
}
GET
/nta/token/supply

Retrieve RSS3 token total supply on VSL

Retrieve the total supply of RSS3 token on VSL.

/nta/token/supply
curl -X GET "https://gi.rss3.io/nta/token/supply"

A successful response containing the total supply of VSL token in RSS3.

{
  "data": {
    "total_supply": "string"
  }
}
GET
/nta/token/tvl

Retrieve TVL in $

Retrieve the total value locked (TVL) in $, including RSS3, WETH, USDT, USDC, and POWER.

/nta/token/tvl
curl -X GET "https://gi.rss3.io/nta/token/tvl"

A successful response containing the TVL of VSL token in USD, including RSS3, WETH, USDT, USDC and POWER.

{
  "data": {
    "tvl": "string"
  }
}
Edit on GitHub

Previous

Get RSS Activity by Path

Next

Retrieve bridging transaction by hash GET