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).
{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.
Path Parameters
id
Requiredstring
Retrieve details for the specified activity ID
Query Parameters
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
action_page
integer
Specify the pagination for actions
1
Minimum: 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.
{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.
Path Parameters
account
Requiredstring
Retrieve activities from the specified account. This account is a unique identifier within the decentralized system.
Query Parameters
limit
integer
Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
since_timestamp
integer
Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.
until_timestamp
integer
Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.
success
boolean
Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.
direction
string
Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.
"in" | "out" | "self"
network
array<string>
Retrieve activities from the specified network(s). You can specify one or more networks.
tag
array<string>
Retrieve activities from the specified tag(s). Tags can be used to categorize activities.
type
array<string>
Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.
platform
array<string>
Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.
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.
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.
Request Body
application/json
RequiredRequest body for batch retrieving activities for multiple accounts
accounts
array<string>
List of accounts to retrieve activities for
limit
integer
Specify the number of activities to retrieve
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
10
Minimum: 1
Maximum: 20
cursor
string
Specify the cursor used for pagination
since_timestamp
integer
Retrieve activities starting from this timestamp
until_timestamp
integer
Retrieve activities up to this timestamp
success
boolean
Retrieve activities based on success status
direction
string
The direction of an activity.
"in" | "out" | "self"
network
array<string>
Retrieve activities from the specified network(s)
tag
array<string>
Retrieve activities for the specified tag(s)
type
array<string>
Retrieve activities for the specified type(s)
platform
array<string>
Retrieve activities from the specified platform(s)
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.
{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.
Path Parameters
network
Requiredstring
Retrieve activities from the specified network.
Query Parameters
limit
integer
Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
since_timestamp
integer
Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.
until_timestamp
integer
Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.
success
boolean
Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.
direction
string
Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.
"in" | "out" | "self"
tag
array<string>
Retrieve activities for the specified tag(s).
type
array<string>
Retrieve activities for the specified type(s).
platform
array<string>
Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.
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.
{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.
Path Parameters
platform
Requiredstring
Retrieve activities from the specified platform.
Query Parameters
limit
integer
Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
since_timestamp
integer
Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.
until_timestamp
integer
Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.
success
boolean
Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.
direction
string
Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.
"in" | "out" | "self"
tag
array<string>
Retrieve activities for the specified tag(s).
type
array<string>
Retrieve activities for the specified type(s).
network
array<string>
Retrieve activities from the specified network(s). You can specify one or more networks.
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.
{path}
Retrieve RSS Activity by Path
Path Parameters
path
Requiredstring
Retrieve details for the specified RSS path
A successful response with the activities from rss feed.
{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.
Path Parameters
id
Requiredstring
Retrieve details for the specified federated activity ID
Query Parameters
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
action_page
integer
Specify the pagination for actions
1
Minimum: 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.
{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.
Path Parameters
account
Requiredstring
Retrieve activities from the specified account. This account is a unique identifier within the federated system.
Query Parameters
limit
integer
Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
since_timestamp
integer
Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.
until_timestamp
integer
Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.
success
boolean
Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.
direction
string
Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.
"in" | "out" | "self"
network
array<string>
Retrieve activities from the specified federated network(s). You can specify one or more federated networks.
tag
array<string>
Retrieve activities from the specified tag(s). Tags can be used to categorize activities.
type
array<string>
Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.
platform
array<string>
Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.
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.
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.
Request Body
application/json
RequiredRequest body for batch retrieving activities for multiple federated accounts
accounts
array<string>
List of federated accounts to retrieve activities
limit
integer
Specify the number of activities to retrieve
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
10
Minimum: 1
Maximum: 20
cursor
string
Specify the cursor used for pagination
since_timestamp
integer
Retrieve activities starting from this timestamp
until_timestamp
integer
Retrieve activities up to this timestamp
success
boolean
Retrieve activities based on success status
direction
string
The direction of an activity.
"in" | "out" | "self"
network
string
Retrieve activities from the specified network(s)
tag
string
Retrieve activities for the specified tag(s)
type
array<string>
Retrieve activities for the specified type(s)
platform
string
Retrieve activities from the specified platform(s)
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.
{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.
Path Parameters
network
Requiredstring
Retrieve activities from the specified federated network.
Query Parameters
limit
integer
Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
since_timestamp
integer
Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.
until_timestamp
integer
Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.
success
boolean
Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.
direction
string
Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.
"in" | "out" | "self"
tag
array<string>
Retrieve activities from the specified tag(s). Tags can be used to categorize activities.
type
array<string>
Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.
platform
array<string>
Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.
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.
{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.
Path Parameters
platform
Requiredstring
Retrieve activities from the specified federated platform.
Query Parameters
limit
integer
Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
since_timestamp
integer
Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.
until_timestamp
integer
Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.
success
boolean
Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.
direction
string
Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.
"in" | "out" | "self"
tag
array<string>
Retrieve activities from the specified tag(s). Tags can be used to categorize activities.
type
array<string>
Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.
network
array<string>
Retrieve activities from the specified federated network(s). You can specify one or more federated networks.
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.
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.
Query Parameters
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
sender
string
Sender address
receiver
string
Receiver address
address
string
Address involved in the transaction
type
string
Type of bridging transaction
"deposit" | "withdraw"
limit
integer
Limit the number of results
50
List of bridging transactions retrieved successfully
{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.
Path Parameters
transaction_hash
Requiredstring
The unique hash of the bridging transaction
Bridging transaction details fetched successfully
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.
Query Parameters
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
staker
string
Staker address
node
string
Node address
type
string
Type of staking transaction
"deposit" | "withdraw" | "stake" | "unstake" | "merge_chips"
pending
boolean
Pending status of the transaction
limit
integer
Limit the number of results
50
List of staking transactions retrieved successfully with pagination cursor
{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.
Path Parameters
transaction_hash
Requiredstring
The unique hash of the staking transaction
Staking transaction details fetched successfully
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.
Query Parameters
staker_address
string
Staker address
node_address
string
Node address
limit
integer
Limit the number of results
50
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
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.
{staker_address}
/profitRetrieve 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).
Path Parameters
staker_address
Requiredstring
The address of the staker whose profit information is to be retrieved.
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.
{staker_address}
/statRetrieve 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.
Path Parameters
staker_address
Requiredstring
The address of the staker whose profit information is to be retrieved.
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.
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.
Query Parameters
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
id
array<integer>
Array of chip IDs to filter the results.
node
string
Node address
owner
string
The address of the chip owner to filter the results.
limit
integer
Limit the number of results
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.
{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.
Path Parameters
chip_id
Requiredinteger
The unique identifier of the chip to retrieve.
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.
{chip_id}
/image.svgRetrieve 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.
Path Parameters
chip_id
Requiredinteger
The unique identifier of the chip to retrieve.
A successful response containing the SVG image of the specified chip. The image can be used to visually represent the chip.
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.
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.
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.
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.
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.
Query Parameters
staker_address
string
Staker address
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
limit
integer
Limit the number of results
50
beforeDate
string
The date before which the snapshots are returned.
"date"
afterDate
string
The date after which the snapshots are returned.
"date"
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.
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.
Query Parameters
node_address
string
Node address
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
limit
integer
Limit the number of results
50
beforeDate
string
The date before which the snapshots are returned.
"date"
afterDate
string
The date after which the snapshots are returned.
"date"
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.
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.
A successful response containing the APY for epoch snapshots. Each entry in the data array includes the epoch details and the corresponding APY.
Retrieve all RSS3 Nodes
Retrieve the list of all RSS3 Nodes. This endpoint allows filtering by cursor, limit, and Node address.
Query Parameters
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
limit
integer
Limit the number of results
50
node
string
Node address
A successful response containing a list of nodes. Each entry includes detailed information about the node.
{address}
Retrieve Node by address
Retrieve Node details by its address.
Path Parameters
address
Requiredstring
The address of the Node to retrieve.
A successful response containing detailed information about the specified node.
{address}
/avatar.svgRetrieve Node avatar by address
Retrieve the avatar of a specific Node by its address. This endpoint returns the SVG image associated with the node.
Path Parameters
address
Requiredstring
The address of the Node to retrieve.
A successful response containing the SVG image of the specified node. The image can be used to visually represent the node.
{address}
/eventsRetrieve 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.
Path Parameters
address
Requiredstring
The address of the Node to retrieve.
Query Parameters
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
limit
integer
Limit the number of results
50
A successful response containing transaction events for the specified node. Each entry in the data array includes detailed information about the event.
{address}
/operation/profitRetrieve 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.
Path Parameters
address
Requiredstring
The address of the Node to retrieve.