Skip to main content

Basic Query API

URL

This URL is the default node URL. To operate on other nodes, simply replace it.

https://hymatrix.ai
tip

Each process has fixed nodes. Transactions must be sent on these fixed nodes to succeed. You can obtain the corresponding nodes via getNodesByProcess.

info​

Retrieve basic information about the HyMatrix network, such as Protocol (name), Variant (version), and Node (default node information).

Parameters

GET https://hymatrix.ai/info

Response Fields

FieldDescription
ProtocolProtocol name, "hymx" represents the HyMatrix protocol.
VariantProtocol version, e.g., "v0.1.1", used to identify the specification version.
Join-NetworkBoolean indicating whether joined the network, true means participating in the Hymx network.
TokenProcessId of the Token.
RegistryIdentifier or address of the registry, used for node registration.
NodeDefault Node information, including node details.

Node Field Descriptions

FieldDescription
Node.Acc-IdNode account address.
Node.NameNode name.
Node.RoleNode role.
Node.DescNode description.
Node.URLAccessible URL of the node. Use this URL for queries or to send transactions.

Example

curl --location --request GET "https://hymatrix.ai/info"

Return


{
  "Protocol": "hymx",
  "Variant": "v0.1.1",
  "Join-Network": true,
  "Token": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "Registry": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
  "Node": {
    "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
    "Name": "testMainNode",
    "Role": "main",
    "Desc": "first test node",
    "URL": "https://hymatrix.ai"
  }
}

getResult​

Retrieve the corresponding result using the known messageId,processId.

Parameters

GET https://hymatrix.ai/result/{{processId}}/{{messageId}}
FieldRequiredDescription
processIdYESprocessId: The process address
messageIdYESmessageId: The id obtained after initiating the transaction

Field Descriptions

FieldDescription
NonceRandom number generated for the transaction. Transactions can be queried using Token processId and Nonce.
TimestampTimestamp when the transaction occurred.
Item-IdUnique identifier generated for the current transaction.
From-ProcessSource process of the transaction.
Pushed-ForTarget process or account the transaction is pushed for.
MessagesContains Sequence (message sequence), Target (wallet address sending the transaction), Data (text message), and Tags (a set of tag labels).
SpawnsSpawned processes or transactions.
AssignmentsAssignment information related to the transaction.
OutputOutput data of the transaction.
DataText data of the transaction.
ErrorError information, if any.

Example

curl --location --request GET "https://hymatrix.ai/result/MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI"

Return

{
  "Nonce": "334",
  "Timestamp": "1757506515032",
  "Item-Id": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
  "From-Process": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "Pushed-For": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
  "Messages": [
    {
      "Sequence": "659",
      "Target": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F",
      "Data": "You staked 1000000000000",
      "Tags": [
        {
          "name": "Ticker",
          "value": "tAX"
        },
        {
          "name": "Action",
          "value": "Stake-Notice"
        },
        {
          "name": "Quantity",
          "value": "1000000000000"
        }
      ]
    },
    {
      "Sequence": "660",
      "Target": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
      "Tags": [
        {
          "name": "Action",
          "value": "Register"
        },
        {
          "name": "Acc-Id",
          "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
        },
        {
          "name": "Name",
          "value": "test1"
        },
        {
          "name": "Role",
          "value": "follower"
        },
        {
          "name": "Desc",
          "value": "first test node"
        },
        {
          "name": "URL",
          "value": "http://101.32.221.225:8080"
        }
      ]
    }
  ],
  "Spawns": null,
  "Assignmengts": null,
  "Output": null,
  "Data": "",
  "Error": ""
}

getResults​

Retrieve the corresponding list of result information using the known processId.

Parameters

GET https://hymatrix.ai/results/{{processId}}?limit={{limit}}
Query FieldRequiredDescription
processIdYESprocessId: The process address
limitNONumber of results to query

Field Descriptions

FieldDescription
edgesList of transaction records, containing cursor (pagination cursor) and node (transaction information, including Nonce, Item-Id, Messages, etc.)

Example

curl --location --request GET "https://hymatrix.ai/results/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4?limit=1"

Return

{
  "edges": [
    {
      "cursor": "eyJ0aW1lc3RhbXAiOjE3NTc1MDY1MTUwMzIsIm9yZGluYXRlIjozMzQsImNyb24iOiIxLTEwLW1pbnV0ZXMiLCJzb3J0IjoiQVNDIn0",
      "node": {
        "Nonce": "334",
        "Timestamp": "1757506515032",
        "Item-Id": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
        "From-Process": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
        "Pushed-For": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
        "Messages": [
          {
            "Sequence": "659",
            "Target": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F",
            "Data": "You staked 1000000000000",
            "Tags": [
              {
                "name": "Ticker",
                "value": "tAX"
              },
              {
                "name": "Action",
                "value": "Stake-Notice"
              },
              {
                "name": "Quantity",
                "value": "1000000000000"
              }
            ]
          },
          {
            "Sequence": "660",
            "Target": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
            "Tags": [
              {
                "name": "Action",
                "value": "Register"
              },
              {
                "name": "Acc-Id",
                "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
              },
              {
                "name": "Name",
                "value": "test1"
              },
              {
                "name": "Role",
                "value": "follower"
              },
              {
                "name": "Desc",
                "value": "first test node"
              },
              {
                "name": "URL",
                "value": "http://101.32.221.225:8080"
              }
            ]
          }
        ],
        "Spawns": null,
        "Assignmengts": null,
        "Output": null,
        "Data": "",
        "Error": ""
      }
    },
    // ...
  ]
}

getMessage​

Retrieve the corresponding Messages information using the known messageId.

Parameters

GET https://hymatrix.ai/message/{{messageId}}
FieldRequiredDescription
messageIdYESmessageId: The id obtained after initiating the transaction

Field Descriptions

FieldDescription
signatureTypeType of signature algorithm, here 3 represents RSA-PSS (Arweave default signing scheme).
signatureSignature string of the transaction initiator, used to verify the message source.
ownerEncoded information of the wallet initiating the transaction.
targetprocessId of the target.
anchor''
tagsA set of tag labels.
dataSigned data.
idIdentifier of the Messages.
tagsByEncoded tag information.

Example

curl --location --request GET "https://hymatrix.ai/message/1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"

Return

{
  "signatureType": 3,
  "signature": "aBg4BXyxsKIaaNs_cJ5XsLuLbtW772EV8XCaxcDdSypIOJR38IuU-XYn8Xp4Sw4UOe3RHHTL3Q4VINBj_LtfLRs",
  "owner": "BCELKi--SONX-yQEKBsip4rFtfrkvXA92fty79n4BrpVTraktwCBPhZOlQC_jukezZ3kO1qZcdNnpfIGZVd7V-Y",
  "target": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "anchor": "",
  "tags": [
    {
      "name": "SDK-Timestamp",
      "value": "1757506904708315269"
    },
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Message"
    },
    {
      "name": "Action",
      "value": "Stake"
    },
    {
      "name": "Quantity",
      "value": "1000000000000"
    },
    {
      "name": "Registry",
      "value": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g"
    },
    {
      "name": "Acc-Id",
      "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
    },
    {
      "name": "Name",
      "value": "test1"
    },
    {
      "name": "Desc",
      "value": "first test node"
    },
    {
      "name": "URL",
      "value": "http://101.32.221.225:8080"
    }
  ],
  "data": "",
  "id": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0",
  "tagsBy": "FhpTREstVGltZXN0YW1wJjE3NTc1MDY5MDQ3MDgzMTUyNjkaRGF0YS1Qcm90b2NvbAhoeW14DlZhcmlhbnQMdjAuMS4wCFR5cGUOTWVzc2FnZQxBY3Rpb24KU3Rha2UQUXVhbnRpdHkaMTAwMDAwMDAwMDAwMBBSZWdpc3RyeVZPLTBfTzRUZ1lZbkE0Vkh3MkV0SFI2TmFmTl9aUlJsWDB1eGtiVU10bzZnDEFjYy1JZFQweGYwNDNjQ0U4QzUwMEFhYTNFQTM0OGMwQjYwMjVDRWI2RDMzNjg4MkYITmFtZQp0ZXN0MQhEZXNjHmZpcnN0IHRlc3Qgbm9kZQZVUkw0aHR0cDovLzEwMS4zMi4yMjEuMjI1OjgwODAA"
}

getMessageByNonce​

Retrieve the corresponding Messages information using the known processId and nonce.

Parameters

GET https://hymatrix.ai/messageByNonce/{{processId}}/{{nonce}}
FieldRequiredDescription
processIdYESprocessId: The process address
nonceYESRandom number from the transaction

Field Descriptions

FieldDescription
signatureTypeSignature algorithm type; here 3 represents RSA-PSS (Arweave default signing scheme).
signatureSignature string from the transaction initiator, used to verify the message source.
ownerEncoded information of the wallet initiating the transaction.
targetprocessId of the target.
anchor''
tagsA set of tag labels.
dataSigned data.
idIdentifier of the Messages.
tagsByEncoded tag information.

Example

curl --location --request GET "https://hymatrix.ai/messageByNonce/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4/338"

Return

{
  "signatureType": 3,
  "signature": "aBg4BXyxsKIaaNs_cJ5XsLuLbtW772EV8XCaxcDdSypIOJR38IuU-XYn8Xp4Sw4UOe3RHHTL3Q4VINBj_LtfLRs",
  "owner": "BCELKi--SONX-yQEKBsip4rFtfrkvXA92fty79n4BrpVTraktwCBPhZOlQC_jukezZ3kO1qZcdNnpfIGZVd7V-Y",
  "target": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "anchor": "",
  "tags": [
    {
      "name": "SDK-Timestamp",
      "value": "1757506904708315269"
    },
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Message"
    },
    {
      "name": "Action",
      "value": "Stake"
    },
    {
      "name": "Quantity",
      "value": "1000000000000"
    },
    {
      "name": "Registry",
      "value": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g"
    },
    {
      "name": "Acc-Id",
      "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
    },
    {
      "name": "Name",
      "value": "test1"
    },
    {
      "name": "Desc",
      "value": "first test node"
    },
    {
      "name": "URL",
      "value": "http://101.32.221.225:8080"
    }
  ],
  "data": "",
  "id": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0",
  "tagsBy": "FhpTREstVGltZXN0YW1wJjE3NTc1MDY5MDQ3MDgzMTUyNjkaRGF0YS1Qcm90b2NvbAhoeW14DlZhcmlhbnQMdjAuMS4wCFR5cGUOTWVzc2FnZQxBY3Rpb24KU3Rha2UQUXVhbnRpdHkaMTAwMDAwMDAwMDAwMBBSZWdpc3RyeVZPLTBfTzRUZ1lZbkE0Vkh3MkV0SFI2TmFmTl9aUlJsWDB1eGtiVU10bzZnDEFjYy1JZFQweGYwNDNjQ0U4QzUwMEFhYTNFQTM0OGMwQjYwMjVDRWI2RDMzNjg4MkYITmFtZQp0ZXN0MQhEZXNjHmZpcnN0IHRlc3Qgbm9kZQZVUkw0aHR0cDovLzEwMS4zMi4yMjEuMjI1OjgwODAA"
}

getAssignByNonce​

Retrieve the corresponding Assign list information using the known processId and nonce.

Parameters

GET https://hymatrix.ai/assignmentByNonce/{{processId}}/{{nonce}}
FieldRequiredDescription
processIdYESprocessId: The process address
nonceYESRandom number from the transaction

Field Descriptions

FieldDescription
signatureTypeSignature algorithm type; here 3 represents RSA-PSS (Arweave default signing scheme).
signatureSignature string from the transaction initiator.
ownerEncoded information of the wallet initiating the transaction.
target''
anchor''
tagsA set of tag labels.
dataSigned data.
idIdentifier of the Assign.
tagsByEncoded tag information.

Example

curl --location --request GET "https://hymatrix.ai/assignmentByNonce/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4/338"

Return

{
  "signatureType": 3,
  "signature": "1TzKoJzunGG38kurXqvSIjbpQr1h5GWfXrjglhn9h7Qn2vxx9iGG2pkANvV1UgdPfhQs_XdLoooGkx2PisPT5hw",
  "owner": "BEJ4yO_ZafTwXM5YzYXS_L6kCIzPJpyn1OR89jI7dRIWcSiBxRMYGM-wFdXqJW4Nla05cr6lxHLZrlIBMZxkwH0",
  "target": "",
  "anchor": "",
  "tags": [
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.2"
    },
    {
      "name": "Type",
      "value": "Assignment"
    },
    {
      "name": "Process",
      "value": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4"
    },
    {
      "name": "Message",
      "value": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"
    },
    {
      "name": "Nonce",
      "value": "338"
    },
    {
      "name": "Timestamp",
      "value": "1757506904731"
    }
  ],
  "data": "",
  "id": "DcJcM96JgSRLhgPEpWmVGidtPjbnN4xwUe28wVDxA2A",
  "tagsBy": "DhpEYXRhLVByb3RvY29sCGh5bXgOVmFyaWFudAx2MC4xLjIIVHlwZRRBc3NpZ25tZW50DlByb2Nlc3NWZkhRYnp3NmFjZzJucW1DcXpkcjJHRmFlb0d6Y1JkMHBhVlREMmtNR3lVNA5NZXNzYWdlVjFHRUpJSjJ1eFdaUVU0cXVPbnN3RE9LRTllTUhtZkxkMjVvdVJ2QW5ZWDAKTm9uY2UGMzM4ElRpbWVzdGFtcBoxNzU3NTA2OTA0NzMxAA"
}

getAssignByMessage​

Retrieve the corresponding Assign information using the known messageId.

Parameters

GET https://hymatrix.ai/assignmentByMessage/{{messageId}}
FieldRequiredDescription
messageIdYESmessageId: The id obtained after initiating the transaction

Field Descriptions

FieldDescription
signatureTypeSignature algorithm type; here 3 represents RSA-PSS (Arweave default signing scheme).
signatureSignature string from the transaction initiator.
ownerEncoded information of the wallet initiating the transaction.
target''
anchor''
tagsA set of tag labels.
dataSigned data.
idIdentifier of the Assign.
tagsByEncoded tag information.

Example

curl --location --request GET "https://hymatrix.ai/assignmentByMessage/1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"

Return

{
  "signatureType": 3,
  "signature": "1TzKoJzunGG38kurXqvSIjbpQr1h5GWfXrjglhn9h7Qn2vxx9iGG2pkANvV1UgdPfhQs_XdLoooGkx2PisPT5hw",
  "owner": "BEJ4yO_ZafTwXM5YzYXS_L6kCIzPJpyn1OR89jI7dRIWcSiBxRMYGM-wFdXqJW4Nla05cr6lxHLZrlIBMZxkwH0",
  "target": "",
  "anchor": "",
  "tags": [
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.2"
    },
    {
      "name": "Type",
      "value": "Assignment"
    },
    {
      "name": "Process",
      "value": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4"
    },
    {
      "name": "Message",
      "value": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"
    },
    {
      "name": "Nonce",
      "value": "338"
    },
    {
      "name": "Timestamp",
      "value": "1757506904731"
    }
  ],
  "data": "",
  "id": "DcJcM96JgSRLhgPEpWmVGidtPjbnN4xwUe28wVDxA2A",
  "tagsBy": "DhpEYXRhLVByb3RvY29sCGh5bXgOVmFyaWFudAx2MC4xLjIIVHlwZRRBc3NpZ25tZW50DlByb2Nlc3NWZkhRYnp3NmFjZzJucW1DcXpkcjJHRmFlb0d6Y1JkMHBhVlREMmtNR3lVNA5NZXNzYWdlVjFHRUpJSjJ1eFdaUVU0cXVPbnN3RE9LRTllTUhtZkxkMjVvdVJ2QW5ZWDAKTm9uY2UGMzM4ElRpbWVzdGFtcBoxNzU3NTA2OTA0NzMxAA"
}

getNode​

Query node information under an account.

Parameters

GET https://hymatrix.ai/node/{{accid}}
FieldRequiredDescription
accidYESaccid: User address

Field Descriptions

FieldDescription
Acc-IdNode account address.
NameNode name.
RoleNode role.
DescNode description.
URLAccessible URL of the node. Use this URL for queries or to send transactions.

Example

curl --location --request GET "https://hymatrix.ai/node/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

Return

{
  "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
  "Name": "TestGenesisNode",
  "Role": "main",
  "Desc": "Test network genesis node",
  "URL": "https://hymatrix.ai"
}

getNodes​

Retrieve information of all nodes.

Parameters

GET https://hymatrix.ai/nodes

Field Descriptions

FieldDescription
Acc-IdNode account address.
NameNode name.
RoleNode role.
DescNode description.
URLAccessible URL of the node. Use this URL for queries or to send transactions.

Example

curl --location --request GET "https://hymatrix.ai/nodes"

Return

{
  "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37": {
    "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
    "Name": "TestGenesisNode",
    "Role": "main",
    "Desc": "Test network genesis node",
    "URL": "https://hymatrix.ai"
  },
  "0x1dc6e69897A650D28190a28C945B140455315acf": {
    "Acc-Id": "0x1dc6e69897A650D28190a28C945B140455315acf",
    "Name": "Arecotest",
    "Role": "follower",
    "Desc": "first test node",
    "URL": "https://152.42.221.139:8080"
  },
  //...
}

getNodesByProcess​

Query node information for a specific process.

Parameters

GET https://hymatrix.ai/nodesByProcess/{{processId}}
FieldRequiredDescription
processIdYESprocessId: The process address

Field Descriptions

FieldDescription
Acc-IdNode account address.
NameNode name.
RoleNode role.
DescNode description.
URLAccessible URL of the node. Use this URL for queries or to send transactions.

Example

curl --location --request GET "https://hymatrix.ai/nodesByProcess/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4"

Return

[
  {
    "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
    "Name": "TestGenesisNode",
    "Role": "main",
    "Desc": "Test network genesis node",
    "URL": "https://hymatrix.ai"
  },
  //...
]

getProcesses​

Query all processes created under an account.

Parameters

GET https://hymatrix.ai/processes/{{accid}}
FieldRequiredDescription
accidYESaccid: User address

Return Data

process 数组

Example

curl --location --request GET "https://hymatrix.ai/processes/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

Return

[
  "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
  "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  //...
]

balanceOf​

Query the balance under an account.

Parameters

GET https://hymatrix.ai/balanceof/{{accid}}
FieldRequiredDescription
accidYESaccid: User address

Example

curl --location --request GET "https://hymatrix.ai/balanceof/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

Return

"0"

stakeOf​

查询账号下质押金额

Parameters

GET https://hymatrix.ai/stakeOf/{{accid}}
FieldRequiredDescription
accidYESaccid: User address

Example

curl --location --request GET "https://hymatrix.ai/stakeOf/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

Return

"0"