Point Network Node API (1.0.0)
Download OpenAPI specification:Download
Point Network Node API Specification
Returns the Point Network Node meta data
Returns the Point Network Node meta data
Authorizations:
Responses
Response samples
- 200
- 400
{- "data": {
- "nodeJsVersion": "v10.16.3",
- "fileCount": 221,
- "peersCount": 2,
- "pointNetworkNodeVersion": "1.0.3",
- "apiRoutes": [
- [
- "GET => /v1/api/status/ping (PingController@ping)",
- "GET => /v1/api/status/meta (StatusController@meta)"
]
], - "wsRoutes": [
- [
- "GET => /ws/node (NodeSocket)"
]
]
}
}Returns a contract instance for the specified cont
Returns a contract instance for the specified contract as an ABI array
Authorizations:
path Parameters
| contract required | string |
Responses
Response samples
- 200
- 404
{- "data": {
- "address": "0xc6AE7d2708633F2cb4c1aC93714873170b5Fd3CC",
- "abi": [
- [
- {
- "inputs": [ ],
- "name": "value",
- "outputs": [
- {
- "internalType": "string",
- "name": "",
- "type": "string"
}
], - "stateMutability": "view",
- "type": "function",
- "constant": true
}
]
]
}
}Returns true if the contract exists at the address
Returns true if the contract exists at the address with the specified ABI
Authorizations:
Request Body schema: application/json
The contract to instantiate
| address required | string |
| abi required | Array of objects (ContractABI) [ items ] |
Responses
Request samples
- Payload
{- "address": "0xc6AE7d2708633F2cb4c1aC93714873170b5Fd3CC",
- "abi": [
- [
- {
- "inputs": [ ],
- "name": "value",
- "outputs": [
- {
- "internalType": "string",
- "name": "",
- "type": "string"
}
], - "stateMutability": "view",
- "type": "function",
- "constant": true
}
]
]
}Response samples
- 200
{- "data": {
- "exists": true
}
}Calls a contract function and returns the data
Calls a contract function and returns the data
Authorizations:
Request Body schema: application/json
The contract, method and params to pass to the called function
| contract required | string |
| method required | string |
| params required | Array of strings |
Responses
Request samples
- Payload
{- "contract": "Store",
- "method": "getProductsByStoreId",
- "params": [
- 1
]
}Response samples
- 200
{- "data": [
- {
- "application": "specific"
}
]
}Sends Eth to a payable contract function to be min
Sends Eth to a payable contract function to be mined in the blockchain and returns the data
Authorizations:
Request Body schema: application/json
The contract, method and params to pass to the called function
| contract required | string |
| method required | string |
| params required | Array of strings |
| amountInWei required | string |
Responses
Request samples
- Payload
{- "contract": "Store",
- "method": "buyProduct",
- "params": [
- 1
], - "amountInWei": 1000000000000000000
}Response samples
- 200
{- "data": [
- { }
]
}Returns owner address from given identity handle
Returns owner address from given identity handle
Authorizations:
path Parameters
| identity required | string The identiy handle for example 'twitter' |
Responses
Response samples
- 200
{- "data": {
- "address": "0x4f5877E51067d0d68784aA74C39871cb2eF2D9eB"
}
}Returns identity handle by owner address
Returns identity handle by owner address
Authorizations:
path Parameters
| owner required | string The owner address for example '0x4f5877E51067d0d68784aA74C39871cb2eF2D9eB' |
Responses
Response samples
- 200
{- "data": {
- "identity": "twitter"
}
}Returns the content signed by the nodes default id
Returns the content signed by the nodes default identity private key
Authorizations:
Request Body schema: application/json
The data payload to sign
| data required | object |
Responses
Request samples
- Payload
{- "data": {
- "any": "data"
}
}Response samples
- 200
{- "data": {
- "signed": { }
}
}Returns the content encrypted by the nodes default
Returns the content encrypted by the nodes default identity private key
Authorizations:
Request Body schema: application/json
The data payload to encrypt
| data required | object |
Responses
Request samples
- Payload
{- "data": {
- "any": "data"
}
}Response samples
- 200
{- "data": {
- "signed": { }
}
}Returns the content decrypted by the nodes default
Returns the content decrypted by the nodes default identity private key
Authorizations:
Request Body schema: application/json
The data payload to decrypt
| data required | object |
Responses
Request samples
- Payload
{- "data": {
- "any": "data"
}
}Response samples
- 200
{- "data": {
- "signed": { }
}
}Returns verification that the content was indeed s
Returns verification that the content was indeed signed by the provided owner address
Authorizations:
path Parameters
| owner required | string The owner address to verify the signed content. For example '0x4f5877E51067d0d68784aA74C39871cb2eF2D9eB' |
Request Body schema: application/json
The data payload to verify
object | |||
| |||
Responses
Request samples
- Payload
{- "data": {
- "signed": { }
}
}Response samples
- 200
{- "data": {
- "verified": true
}
}Returns a file from the Storage Layer
Returns a file from the Storage Layer
Authorizations:
query Parameters
| encoding | string Enum: "utf-8" "base64" "binary" "hex" |
Responses
Response samples
- 200
{- "data": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAADXwElEQVR42ux9B5wU5fn/d8r23StwdBGw0pQmYscSa6xRY6LRoMbEFltiT4z5+dcktqiJJVbsGmPvvYEKUgRBaTY6"
}Returns a list of metadata about all the files rec
Returns a list of metadata about all the files recorded in the node database
Authorizations:
Responses
Response samples
- 200
{- "files": [
- {
- "id": "288ac655fb9aa15abc790d57d862f3c85c5fa9b1d0fb8c6d9d6f50447587356f",
- "localPath": "/Users/developer/.point/test2/data/deployer_cache/a40acf739591f4260467e3ba06aa4c1cf076ea2fc3b1fa66cd3fadec0e9788cc",
- "size": 25,
- "redundancy": 1,
- "expires": 1624260434171,
- "autorenew": true,
- "chunkCount": 1
}
]
}Returns a single files metadata loaded from the no
Returns a single files metadata loaded from the nodes database
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
{- "file": {
- "localPath": "/Users/developer/.point/test2/data/deployer_cache/a40acf739591f4260467e3ba06aa4c1cf076ea2fc3b1fa66cd3fadec0e9788cc",
- "size": 25,
- "chunkIds": [
- "a40acf739591f4260467e3ba06aa4c1cf076ea2fc3b1fa66cd3fadec0e9788cc"
], - "id": "288ac655fb9aa15abc790d57d862f3c85c5fa9b1d0fb8c6d9d6f50447587356f",
- "redundancy": 1,
- "expires": 1624260434171,
- "autorenew": true,
- "ul_status": "us99"
}
}Returns a list of metadata about all the chunks re
Returns a list of metadata about all the chunks recorded in the node database
Authorizations:
Responses
Response samples
- 200
{- "chunks": [
- {
- "id": "0f1a97888f3c63318bceedd0461c8efe2778a3e1a49934045ee8314d94e335be",
- "redundancy": 1,
- "expires": 1624260423041,
- "autorenew": true
}
]
}Returns a single chunks metadata loaded from the n
Returns a single chunks metadata loaded from the nodes database
Authorizations:
path Parameters
| id required | string |
Responses
Response samples
- 200
{- "chunk": {
- "chunk": {
- "belongsToFiles": [
- [
- "e86226f43b01ae4787eba0bc5bc09c5a68f502da324c62446a4b9c0f22269521",
- 0,
- "/Users/developer/.point/test2/data/deployer_cache/0f1a97888f3c63318bceedd0461c8efe2778a3e1a49934045ee8314d94e335be"
]
], - "ul_status": "us99",
- "id": "0f1a97888f3c63318bceedd0461c8efe2778a3e1a49934045ee8314d94e335be",
- "redundancy": 1,
- "expires": 1624260423041,
- "autorenew": true,
- "dl_status": "ds99",
- "length": 120554
}
}
}