JSON API
Basic API
/api/pin/{numberOrId}
GET
PIN number or PIN id
Get PIN Details by PIN Number or PIN ID
/api/address/pin/list/{addressType/{address}
GET
address addressType :creator,owner
Retrieve the list of PINs created or owned by the specified address.
/api/address/pin/root/{address}
GET
address
Get PIN Root by Address
/api/node/child/{pinId}
GET
pinId
Get Child Node by PIN ID
/api/node/parent/{pinId}
GET
pinId
Get Parent Node by PIN ID
/api/info/address/{address}
GET
address
Get MetaID Info by Address
/api/info/rootId/{rootId}
GET
rootId
Get MetaID Info by Root ID
/api/pin/content/{numberOrId}
GET
PIN number or PIN id
Get PIN Content by PIN Number or PIN ID
/api/getAllPinByParentPath
GET
page,limit,parentPath
Get All Pins by Parent Path
generalQuery
General query for protocols data, supporting data retrieval in get, count, and sum methods.
Endpoint: /api/generalQuery
method: POST
{
"collection": "pins", // Name of the collection to query, required
"action": "sum", // Query operation, supports get, count, sum
"filterRelation": "or", // Query condition relationship, supports or, and. Currently does not support mixing.
"field": [
"number" // Field(s) to return in the query, required for sum operation
],
// Query conditions
"filter": [
{
"operator": "=", // Condition operator, supports =, >, >=, <, <=
"key": "number", // Field to apply the condition
"value": 1 // Value to query
},
{
"operator": "=",
"key": "number",
"value": 2
}
],
"cursor": 0, // Starting point for returning data
"limit": 1, // Number of data records to return
"sort": [
"number", // Field to sort by
"desc" // Order, supports asc, desc
]
}Successful Response Example
Failed Response Example
Last updated