getActivity
Introduction
The getActivity method retrieves a single activity record from the node's ActivityStorage by its unique id. Unlike the activity2 endpoint which returns paginated lists, this method is designed for looking up a specific activity entry — for example, to check the current status of a known transaction or to display detailed information for a particular event.
The returned object includes the full transaction data when available, making this endpoint ideal for building detail views or for verifying that a specific activity has reached a desired status.
Request
Requests can be made using either HTTP POST with a JSON body (recommended) or HTTP GET with URL query parameters.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier of the activity to retrieve. This is the same id value returned in the ActivityObject from the activity2 endpoint. |
Example POST Request
POST /getActivity
Content-Type: application/json
{
"method": "getActivity",
"params": {
"id": "stk-478387-478392-22NsqTQCGkWa6gyRHYsQbbJNCvC8vVzer6WnV4g9ThuHDdtKkpcKGMfiYGneA"
},
"id": 1
}
Example GET Request
The params object is flattened into URL query string parameters.
GET /getActivity?id=stk-478387-478392-22NsqTQCGkWa6gyRHYsQbbJNCvC8vVzer6WnV4g9ThuHDdtKkpcKGMfiYGneA
Response
The response format is a standard JSON-RPC object, regardless of whether the request was made via GET or POST. The result is a single ActivityObject if the activity is found, or null if no activity matches the given id.
Result: ActivityObject Structure
| Name | Type | Description |
|---|---|---|
id | string | A unique identifier for this activity entry. |
seedHash | string | The Base64-encoded seed hash of the associated wallet. |
type | integer | An enum value identifying the type of the activity. See the ActivityType table below. |
timestamp | integer | The Unix Epoch timestamp (in seconds) when the event occurred. |
status | integer | An enum value indicating the status of the activity. See the ActivityStatus table below. |
fromAddressList | object | A map of sender addresses to their IxiNumber values involved in the activity. |
toAddressList | object | A map of recipient addresses to their IxiNumber values involved in the activity. |
value | IxiNumber | The primary value of the activity, represented as a string to preserve precision. |
fee | IxiNumber | The fee associated with the transaction, represented as a string. |
appliedBlockHeight | integer | The block number in which this activity was recorded. |
transaction | object | null | The full transaction object associated with the activity. Included when available, as the lookup is performed with includeTransaction = true. |
Example Success Response
{
"result": {
"id": "5938914-ssPPYPwBiKfHBE9Xntp4fBXwCJYitzKTzSta425VB94EKMjRoUmv7n66CFQE",
"seedHash": "AVr8pK+MQIGQ2iieR59mvw==",
"type": 100,
"timestamp": 1779302126,
"status": 2,
"fromAddressList": {
"5FZf4fb11tduchtHxzfp5n6jA8bvod1NXQSoaujZvA3Z6LD6ZM1WpNQAXExhbE1yr": "10.03000000"
},
"toAddressList": {
"3tFzB7DygYiyjfZ9RbHaZJNaPGgF25E8otFbM3rGMkTC98feQdKDBw4MKzfg48E3L": "10.00000000"
},
"value": "10.00000000",
"fee": "0.01000000",
"appliedBlockHeight": 5938917,
"transaction": {
"version": 7,
"id": "Af3inloAnHP5TTimjZxh/rAHT32S7F+I0uyFZ6auL+TIA10XEWQdXGwSLYO1JY0kK6M=",
"type": 0,
"amount": {
"amount": 1002000000
},
"fee": {
"amount": 1000000
},
"fromList": {
"AA==": {
"amount": 1003000000
}
},
"toList": {
"3tFzB7DygYiyjfZ9RbHaZJNaPGgF25E8otFbM3rGMkTC98feQdKDBw4MKzfg48E3L": {
"amount": {
"amount": 1000000000
},
"data": "dXNlcjEyMw==",
"dataChecksum": "+rH10RK6ZQ+Ma30JBfLl6THb6AJRNrFjLXyOQMcrE6c="
},
"3TA9meGrkwoX8fJzQReuF1sxLZkNyRgbUKqJysfy6vqshAoMVAzvQKXgAkbJDaCNA": {
"amount": {
"amount": 1000000
},
"data": null,
"dataChecksum": null
},
"4oBtGYZBJwGUD7RaxHigXva73Hyd2ZKTtCZ8QhhDDfGhd6dCQZJuBom15BwxQu61T": {
"amount": {
"amount": 1000000
},
"data": null,
"dataChecksum": null
}
},
"blockHeight": 5938914,
"nonce": 59250,
"timeStamp": 0,
"checksum": "...",
"signature": "...",
"pubKey": { ... },
"readyToApply": 0,
"applied": 5938917,
"fromLocalStorage": false,
"powVerified": false,
"powSolution": null
}
},
"error": null,
"id": null
}
Example Not Found Response
If no activity with the given id exists, the result is null with no error.
{
"result": null,
"error": null,
"id": 1
}
Example Error Response: Missing Parameter
This error is returned if the required id parameter is not provided.
{
"result": null,
"id": 1,
"error": {
"code": -32602,
"message": "Missing parameter 'id'"
}
}
Example Error Response: ActivityStorage Not Available
This error is returned if the node is not configured to provide the ActivityStorage service.
{
"result": null,
"id": 1,
"error": {
"code": -32603,
"message": "/getActivity can't be used, because ActivityStorage was not implemented."
}
}
Enumerations
ActivityType
| Value | Name | Description |
|---|---|---|
0 | None | An uninitialized or unspecified activity type. |
100 | TransactionReceived | A standard IXI transaction was received by the wallet. |
101 | TransactionSent | A standard IXI transaction was sent from the wallet. |
200 | MiningReward | A reward for PoW mining was generated. |
201 | SigningReward | A reward for signing participation was received. |
300 | ContactRequest | A contact request was received. |
400 | IxiName | An IXI Name registration or management transaction. |
ActivityStatus
| Value | Name | Description |
|---|---|---|
1 | Pending | The activity is not yet confirmed in the blockchain. |
2 | Final | The activity is finalized and included in the blockchain. |
3 | Expired | The activity has expired. |
4 | Reverted | The activity was reverted (e.g., due to a block reorg). |
5 | Rejected | The activity was rejected. |
6 | Unknown | The activity status is unknown. |
Behavioral Notes
- Single Lookup: This endpoint returns a single
ActivityObjectornull. It does not support pagination or filtering. To retrieve lists of activities, use theactivity2endpoint instead. - Transaction Inclusion: The
getActivityendpoint always attempts to include the fulltransactionobject in the response. The transaction data is stored separately and may benullif it is not available in the node'sActivityStorage. - ID Format: The
idparameter uses the same format as theidfield returned in activity objects. Typically, this is a string such as a transaction ID or a composite identifier likestk-{blockFrom}-{blockTo}-{txId}. - Node Configuration: This endpoint is only available on nodes that have the
ActivityStoragemodule enabled and fully synchronized.