sido/node
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
node/doc/api_data.js
pxgamer 5dced856e2 Fix reference to transaction limit in the API
2019-04-09 16:51:13 +01:00

1898 lines
51 KiB
JavaScript
Raw Permalink Blame History

define({ "api": [
{
"type": "get",
"url": "/api.php",
"title": "01. Basic Information",
"name": "Info",
"group": "API",
"description": "<p>Each API call will return the result in JSON format. There are 2 objects, &quot;status&quot; and &quot;data&quot;.</p> <p>The &quot;status&quot; object returns &quot;ok&quot; when the transaction is successful and &quot;error&quot; on failure.</p> <p>The &quot;data&quot; object returns the requested data, as sub-objects.</p> <p>The parameters must be sent either as POST['data'], json encoded array or independently as GET.</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "status",
"description": "<p>&quot;ok&quot;</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "data",
"description": "<p>The data provided by the api will be under this object.</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "{\n \"status\":\"ok\",\n \"data\":{\n \"obj1\":\"val1\",\n \"obj2\":\"val2\",\n \"obj3\":{\n \"obj4\":\"val4\",\n \"obj5\":\"val5\"\n }\n }\n}",
"type": "json"
}
]
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"type": "String",
"optional": false,
"field": "status",
"description": "<p>&quot;error&quot;</p>"
},
{
"group": "Error 4xx",
"type": "String",
"optional": false,
"field": "result",
"description": "<p>Information regarding the error</p>"
}
]
},
"examples": [
{
"title": "Error-Response:",
"content": "{\n \"status\": \"error\",\n \"data\": \"The requested action could not be completed.\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=base58",
"title": "03. base58",
"name": "base58",
"group": "API",
"description": "<p>Converts a string to base58.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>Input string</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>Output string</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=checkAddress",
"title": "22. checkAddress",
"name": "checkAddress",
"group": "API",
"description": "<p>Checks the validity of an address.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "account",
"description": "<p>Account id / address</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data",
"description": "<p>True if the address is valid, false otherwise.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=checkSignature",
"title": "17. checkSignature",
"name": "checkSignature",
"group": "API",
"description": "<p>Checks a signature against a public key</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "signature",
"description": "<p>signature</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "data",
"description": "<p>signed data</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data",
"description": "<p>true or false</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=currentBlock",
"title": "10. currentBlock",
"name": "currentBlock",
"group": "API",
"description": "<p>Returns the current block.</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "id",
"description": "<p>Blocks id</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "generator",
"description": "<p>Block Generator</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "height",
"description": "<p>Height</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "date",
"description": "<p>Block's date in UNIX TIMESTAMP format</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "nonce",
"description": "<p>Mining nonce</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "signature",
"description": "<p>Signature signed by the generator</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "difficulty",
"description": "<p>The base target / difficulty</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "argon",
"description": "<p>Mining argon hash</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=generateAccount",
"title": "09. generateAccount",
"name": "generateAccount",
"group": "API",
"description": "<p>Generates a new account. This function should only be used when the node is on the same host or over a really secure network.</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "address",
"description": "<p>Account address</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "private_key",
"description": "<p>Private key</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getAddress",
"title": "02. getAddress",
"name": "getAddress",
"group": "API",
"description": "<p>Converts the public key to an ARO address.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "public_key",
"description": "<p>The public key</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>Contains the address</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getAlias",
"title": "19. getAlias",
"name": "getAlias",
"group": "API",
"description": "<p>Returns the alias of an account</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "account",
"description": "<p>Account id / address</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>alias</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getBalance",
"title": "04. getBalance",
"name": "getBalance",
"group": "API",
"description": "<p>Returns the balance of a specific account or public key.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "account",
"description": "<p>Account id / address</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "alias",
"description": "<p>alias</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>The ARO balance</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getBlock",
"title": "11. getBlock",
"name": "getBlock",
"group": "API",
"description": "<p>Returns the block.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "numeric",
"optional": false,
"field": "height",
"description": "<p>Block Height</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "id",
"description": "<p>Block id</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "generator",
"description": "<p>Block Generator</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "height",
"description": "<p>Height</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "date",
"description": "<p>Block's date in UNIX TIMESTAMP format</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "nonce",
"description": "<p>Mining nonce</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "signature",
"description": "<p>Signature signed by the generator</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "difficulty",
"description": "<p>The base target / difficulty</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "argon",
"description": "<p>Mining argon hash</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getBlockTransactions",
"title": "12. getBlockTransactions",
"name": "getBlockTransactions",
"group": "API",
"description": "<p>Returns the transactions of a specific block.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "numeric",
"optional": true,
"field": "height",
"description": "<p>Block Height</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "block",
"description": "<p>Block id</p>"
},
{
"group": "Parameter",
"type": "boolean",
"optional": true,
"field": "includeMiningRewards",
"description": "<p>Include mining rewards</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "block",
"description": "<p>Block ID</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "confirmations",
"description": "<p>Number of confirmations</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "date",
"description": "<p>Transaction's date in UNIX TIMESTAMP format</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "dst",
"description": "<p>Transaction destination</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "fee",
"description": "<p>The transaction's fee</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "height",
"description": "<p>Block height</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "id",
"description": "<p>Transaction ID/HASH</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "message",
"description": "<p>Transaction's message</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "signature",
"description": "<p>Transaction's signature</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "public_key",
"description": "<p>Account's public_key</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "src",
"description": "<p>Sender's address</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "type",
"description": "<p>&quot;debit&quot;, &quot;credit&quot; or &quot;mempool&quot;</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "val",
"description": "<p>Transaction value</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "version",
"description": "<p>Transaction version</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getPendingBalance",
"title": "05. getPendingBalance",
"name": "getPendingBalance",
"group": "API",
"description": "<p>Returns the pending balance, which includes pending transactions, of a specific account or public key.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "account",
"description": "<p>Account id / address</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>The ARO balance</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getPublicKey",
"title": "08. getPublicKey",
"name": "getPublicKey",
"group": "API",
"description": "<p>Returns the public key of a specific account.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "account",
"description": "<p>Account id / address</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>The public key</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getTransaction",
"title": "07. getTransaction",
"name": "getTransaction",
"group": "API",
"description": "<p>Returns one transaction.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "transaction",
"description": "<p>Transaction ID</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "block",
"description": "<p>Block ID</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "confirmation",
"description": "<p>Number of confirmations</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "date",
"description": "<p>Transaction's date in UNIX TIMESTAMP format</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "dst",
"description": "<p>Transaction destination</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "fee",
"description": "<p>The transaction's fee</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "height",
"description": "<p>Block height</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "id",
"description": "<p>Transaction ID/HASH</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "message",
"description": "<p>Transaction's message</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "signature",
"description": "<p>Transaction's signature</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "public_key",
"description": "<p>Account's public_key</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "src",
"description": "<p>Sender's address</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "type",
"description": "<p>&quot;debit&quot;, &quot;credit&quot; or &quot;mempool&quot;</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "val",
"description": "<p>Transaction value</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "version",
"description": "<p>Transaction version</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=getTransactions",
"title": "06. getTransactions",
"name": "getTransactions",
"group": "API",
"description": "<p>Returns the latest transactions of an account.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "public_key",
"description": "<p>Public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "account",
"description": "<p>Account id / address</p>"
},
{
"group": "Parameter",
"type": "numeric",
"optional": true,
"field": "limit",
"description": "<p>Number of confirmed transactions, max 100, min 1</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "block",
"description": "<p>Block ID</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "confirmation",
"description": "<p>Number of confirmations</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "date",
"description": "<p>Transaction's date in UNIX TIMESTAMP format</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "dst",
"description": "<p>Transaction destination</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "fee",
"description": "<p>The transaction's fee</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "height",
"description": "<p>Block height</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "id",
"description": "<p>Transaction ID/HASH</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "message",
"description": "<p>Transaction's message</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "signature",
"description": "<p>Transaction's signature</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "public_key",
"description": "<p>Account's public_key</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "src",
"description": "<p>Sender's address</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "type",
"description": "<p>&quot;debit&quot;, &quot;credit&quot; or &quot;mempool&quot;</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "val",
"description": "<p>Transaction value</p>"
},
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "version",
"description": "<p>Transaction version</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=masternodes",
"title": "18. masternodes",
"name": "masternodes",
"group": "API",
"description": "<p>Returns all the masternode data</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data",
"description": "<p>masternode date</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=mempoolSize",
"title": "15. mempoolSize",
"name": "mempoolSize",
"group": "API",
"description": "<p>Returns the number of transactions in mempool.</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "data",
"description": "<p>Number of mempool transactions</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=node-info",
"title": "21. node-info",
"name": "node_info",
"group": "API",
"description": "<p>Returns details about the node.</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "object",
"optional": false,
"field": "data",
"description": "<p>A collection of data about the node.</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data.hostname",
"description": "<p>The hostname of the node.</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data.version",
"description": "<p>The current version of the node.</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data.dbversion",
"description": "<p>The database schema version for the node.</p>"
},
{
"group": "Success 200",
"type": "number",
"optional": false,
"field": "data.accounts",
"description": "<p>The number of accounts known by the node.</p>"
},
{
"group": "Success 200",
"type": "number",
"optional": false,
"field": "data.transactions",
"description": "<p>The number of transactions known by the node.</p>"
},
{
"group": "Success 200",
"type": "number",
"optional": false,
"field": "data.mempool",
"description": "<p>The number of transactions in the mempool.</p>"
},
{
"group": "Success 200",
"type": "number",
"optional": false,
"field": "data.masternodes",
"description": "<p>The number of masternodes known by the node.</p>"
},
{
"group": "Success 200",
"type": "number",
"optional": false,
"field": "data.peers",
"description": "<p>The number of valid peers.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=randomNumber",
"title": "16. randomNumber",
"name": "randomNumber",
"group": "API",
"description": "<p>Returns a random number based on an ARO block id.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "numeric",
"optional": false,
"field": "height",
"description": "<p>The height of the block on which the random number will be based on (should be a future block when starting)</p>"
},
{
"group": "Parameter",
"type": "numeric",
"optional": false,
"field": "min",
"description": "<p>Minimum number (default 1)</p>"
},
{
"group": "Parameter",
"type": "numeric",
"optional": false,
"field": "max",
"description": "<p>Maximum number</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "seed",
"description": "<p>A seed to generate different numbers for each use cases.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "numeric",
"optional": false,
"field": "data",
"description": "<p>The random number</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=sanity",
"title": "20. sanity",
"name": "sanity",
"group": "API",
"description": "<p>Returns details about the node's sanity process.</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "object",
"optional": false,
"field": "data",
"description": "<p>A collection of data about the sanity process.</p>"
},
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data.sanity_running",
"description": "<p>Whether the sanity process is currently running.</p>"
},
{
"group": "Success 200",
"type": "number",
"optional": false,
"field": "data.last_sanity",
"description": "<p>The timestamp for the last time the sanity process was run.</p>"
},
{
"group": "Success 200",
"type": "boolean",
"optional": false,
"field": "data.sanity_sync",
"description": "<p>Whether the sanity process is currently synchronising.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=send",
"title": "14. send",
"name": "send",
"group": "API",
"description": "<p>Sends a transaction.</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "numeric",
"optional": false,
"field": "val",
"description": "<p>Transaction value (without fees)</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "dst",
"description": "<p>Destination address</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "public_key",
"description": "<p>Sender's public key</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "signature",
"description": "<p>Transaction signature. It's recommended that the transaction is signed before being sent to the node to avoid sending your private key to the node.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "private_key",
"description": "<p>Sender's private key. Only to be used when the transaction is not signed locally.</p>"
},
{
"group": "Parameter",
"type": "numeric",
"optional": true,
"field": "date",
"description": "<p>Transaction's date in UNIX TIMESTAMP format. Requried when the transaction is pre-signed.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": true,
"field": "message",
"description": "<p>A message to be included with the transaction. Maximum 128 chars.</p>"
},
{
"group": "Parameter",
"type": "numeric",
"optional": true,
"field": "version",
"description": "<p>The version of the transaction. 1 to send coins.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>Transaction id</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "get",
"url": "/api.php?q=version",
"title": "13. version",
"name": "version",
"group": "API",
"description": "<p>Returns the node's version.</p>",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "data",
"description": "<p>Version</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./api.php",
"groupTitle": "API"
},
{
"type": "php util.php",
"url": "balance",
"title": "Balance",
"name": "balance",
"group": "UTIL",
"description": "<p>Prints the balance of an address or a public key</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "text",
"optional": false,
"field": "arg2",
"description": "<p>address or public_key</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php balance 5WuRMXGM7Pf8NqEArVz1NxgSBptkimSpvuSaYC79g1yo3RDQc8TjVtGH5chQWQV7CHbJEuq9DmW5fbmCEW4AghQr",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "Balance: 2,487",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "block",
"title": "Block",
"name": "block",
"group": "UTIL",
"description": "<p>Returns a specific block</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "text",
"optional": false,
"field": "arg2",
"description": "<p>block id</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php block 4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "array(9) {\n [\"id\"]=>\n string(88) \"4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR\"\n [\"generator\"]=>\n string(88) \"5ADfrJUnLefPsaYjMTR4KmvQ79eHo2rYWnKBRCXConYKYJVAw2adtzb38oUG5EnsXEbTct3p7GagT2VVZ9hfVTVn\"\n [\"height\"]=>\n int(16833)\n [\"date\"]=>\n int(1519312385)\n [\"nonce\"]=>\n string(41) \"EwtJ1EigKrLurlXROuuiozrR6ICervJDF2KFl4qEY\"\n [\"signature\"]=>\n string(97) \"AN1rKpqit8UYv6uvf79GnbjyihCPE1UZu4CGRx7saZ68g396yjHFmzkzuBV69Hcr7TF2egTsEwVsRA3CETiqXVqet58MCM6tu\"\n [\"difficulty\"]=>\n string(8) \"61982809\"\n [\"argon\"]=>\n string(68) \"$SfghIBNSHoOJDlMthVcUtg$WTJMrQWHHqDA6FowzaZJ+O9JC8DPZTjTxNE4Pj/ggwg\"\n [\"transactions\"]=>\n int(0)\n}",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "block-time",
"title": "Block-time",
"name": "block_time",
"group": "UTIL",
"description": "<p>Shows the block time of the last 100 blocks</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php block-time",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "16830 -> 323\n...\n16731 -> 302\nAverage block time: 217 seconds",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "blocks",
"title": "Blocks",
"name": "blocks",
"group": "UTIL",
"description": "<p>Prints the id and the height of the blocks &gt;=arg2, max 100 or arg3</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "number",
"optional": false,
"field": "arg2",
"description": "<p>Starting height</p>"
},
{
"group": "Parameter",
"type": "number",
"optional": true,
"field": "arg3",
"description": "<p>Block Limit</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php blocks 10800 5",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "10801 2yAHaZ3ghNnThaNK6BJcup2zq7EXuFsruMb5qqXaHP9M6JfBfstAag1n1PX7SMKGcuYGZddMzU7hW87S5ZSayeKX\n10802 wNa4mRvRPCMHzsgLdseMdJCvmeBaCNibRJCDhsuTeznJh8C1aSpGuXRDPYMbqKiVtmGAaYYb9Ze2NJdmK1HY9zM\n10803 3eW3B8jCFBauw8EoKN4SXgrn33UBPw7n8kvDDpyQBw1uQcmJQEzecAvwBk5sVfQxUqgzv31JdNHK45JxUFcupVot\n10804 4mWK1f8ch2Ji3D6aw1BsCJavLNBhQgpUHBCHihnrLDuh8Bjwsou5bQDj7D7nV4RsEPmP2ZbjUUMZwqywpRc8r6dR\n10805 5RBeWXo2c9NZ7UF2ubztk53PZpiA4tsk3bhXNXbcBk89cNqorNj771Qu4kthQN5hXLtu1hzUnv7nkH33hDxBM34m",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "check-address",
"title": "Check-Address",
"name": "check_address",
"group": "UTIL",
"description": "<p>Checks a specific address for validity</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "text",
"optional": false,
"field": "arg2",
"description": "<p>block id</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php check-address 4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "The address is valid",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "clean",
"title": "Clean",
"name": "clean",
"group": "UTIL",
"description": "<p>Cleans the entire database</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php clean",
"type": "cli"
}
],
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "clean-blacklist",
"title": "Clean-Blacklist",
"name": "clean_blacklist",
"group": "UTIL",
"description": "<p>Removes all the peers from blacklist</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php clean-blacklist",
"type": "cli"
}
],
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "current",
"title": "Current",
"name": "current",
"group": "UTIL",
"description": "<p>Prints the current block in var_dump</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php current",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "array(9) {\n [\"id\"]=>\n string(88) \"4khstc1AknzDXg8h2v12rX42vDrzBaai6Rz53mbaBsghYN4DnfPhfG7oLZS24Q92MuusdYmwvDuiZiuHHWgdELLR\"\n [\"generator\"]=>\n string(88) \"5ADfrJUnLefPsaYjMTR4KmvQ79eHo2rYWnKBRCXConYKYJVAw2adtzb38oUG5EnsXEbTct3p7GagT2VVZ9hfVTVn\"\n [\"height\"]=>\n int(16833)\n [\"date\"]=>\n int(1519312385)\n [\"nonce\"]=>\n string(41) \"EwtJ1EigKrLurlXROuuiozrR6ICervJDF2KFl4qEY\"\n [\"signature\"]=>\n string(97) \"AN1rKpqit8UYv6uvf79GnbjyihCPE1UZu4CGRx7saZ68g396yjHFmzkzuBV69Hcr7TF2egTsEwVsRA3CETiqXVqet58MCM6tu\"\n [\"difficulty\"]=>\n string(8) \"61982809\"\n [\"argon\"]=>\n string(68) \"$SfghIBNSHoOJDlMthVcUtg$WTJMrQWHHqDA6FowzaZJ+O9JC8DPZTjTxNE4Pj/ggwg\"\n [\"transactions\"]=>\n int(0)\n}",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "delete-peer",
"title": "Delete-peer",
"name": "delete_peer",
"group": "UTIL",
"description": "<p>Removes a peer from the peerlist</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "text",
"optional": false,
"field": "arg2",
"description": "<p>Peer's hostname</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php delete-peer http://peer1.arionum.com",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "Peer removed",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "get-address",
"title": "Get-Address",
"name": "get_address",
"group": "UTIL",
"description": "<p>Converts a public key into an address</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "text",
"optional": false,
"field": "arg2",
"description": "<p>public key</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php get-address PZ8Tyr4Nx8MHsRAGMpZmZ6TWY63dXWSCwQr8cE5s6APWAE1SWAmH6NM1nJTryBURULEsifA2hLVuW5GXFD1XU6s6REG1iPK7qGaRDkGpQwJjDhQKVoSVkSNp",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "5WuRMXGM7Pf8NqEArVz1NxgSBptkimSpvuSaYC79g1yo3RDQc8TjVtGH5chQWQV7CHbJEuq9DmW5fbmCEW4AghQr",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "mempool",
"title": "Mempool",
"name": "mempool",
"group": "UTIL",
"description": "<p>Prints the number of transactions in mempool</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php mempool",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "Mempool size: 12",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "peer",
"title": "Peer",
"name": "peer",
"group": "UTIL",
"description": "<p>Creates a peering session with another node</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "text",
"optional": false,
"field": "arg2",
"description": "<p>The Hostname of the other node</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php peer http://peer1.arionum.com",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "Peering OK",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "peers",
"title": "Peers",
"name": "peers",
"group": "UTIL",
"description": "<p>Prints all the peers and their status</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php peers",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "http://35.190.160.142 active\n...\nhttp://aro.master.hashpi.com active",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "peers-block",
"title": "Peers-Block",
"name": "peers_block",
"group": "UTIL",
"description": "<p>Prints the current height of all the peers</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php peers-block",
"type": "cli"
}
],
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "http://peer5.arionum.com 16849\n...\nhttp://peer10.arionum.com 16849",
"type": "text"
}
]
},
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "pop",
"title": "Pop",
"name": "pop",
"group": "UTIL",
"description": "<p>Cleans the entire database</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "arg2",
"description": "<p>Number of blocks to delete</p>"
}
]
}
},
"examples": [
{
"title": "Example usage:",
"content": "php util.php pop 1",
"type": "cli"
}
],
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"type": "php util.php",
"url": "recheck-blocks",
"title": "Recheck-Blocks",
"name": "recheck_blocks",
"group": "UTIL",
"description": "<p>Recheck all the blocks to make sure the blockchain is correct</p>",
"examples": [
{
"title": "Example usage:",
"content": "php util.php recheck-blocks",
"type": "cli"
}
],
"version": "0.0.0",
"filename": "./util.php",
"groupTitle": "UTIL"
},
{
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"optional": false,
"field": "varname1",
"description": "<p>No type.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "varname2",
"description": "<p>With type.</p>"
}
]
}
},
"type": "",
"url": "",
"version": "0.0.0",
"filename": "./doc/main.js",
"group": "_github_node_doc_main_js",
"groupTitle": "_github_node_doc_main_js",
"name": ""
}
] });
Reference in New Issue View Git Blame Copy Permalink