NAV navbar
logo

Era_RPC Documentation

version 1
baseUri http://127.0.0.1:9048
protocols HTTP

seed


seed get

GET: /seed

generate random seed


seed get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/seed"

assets


assets get

GET: /assets

Returns an array of keys of assets with names.


assets get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/assets"


/full get

GET: /assets/full

Returns an array of assets with full information.


/full get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/assets/full"


/{key} get

GET: /assets/{key}

Returns short information about asset with the given key.


URI Parameters

key

PropertyValue
requiredtrue
typestring

/{key} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/assets/{key}"


/full get

GET: /assets/{key}/full

Returns full information about asset with the given key. Errors:601- Invalid asset ID.


URI Parameters

key

PropertyValue
requiredtrue
typestring

/full get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/assets/{key}/full"

wallet


wallet get

GET: /wallet

Returns general information about the wallet.{"exists":true,"isunlocked":false}


wallet get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/wallet"

wallet post

POST: /wallet

Creates a wallet using the given 32-byte long base58-encoded seed, password,recover flag and amount. Errors: 1 - Json error 103 - Invalid seed. 104 - Invalid amount. 204 - Wallet already exists.


wallet post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/wallet" \
	-d @request_body

REQUEST BODY

{
  "seed": "<seed>",
  "password": "<password>",
  "recover": "<false/true>",
  "amount": "<amount>"
}


/seed get

GET: /wallet/seed

Return the 32-byte long base58-encoded wallet seed. Errors: 201 - Wallet does not exist. 203 - Wallet is locked.


/seed get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/wallet/seed"


/unlock post

POST: /wallet/unlock

unlock wallet


Query Parameters

password
password of wallet

PropertyValue
requiredtrue
typestring

/unlock post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/wallet/unlock" \
	-d @request_body


/lock get

GET: /wallet/lock

Locks the wallet. Errors: 201 - Wallet does not exist.


/lock get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/wallet/lock"


/synchronize get

GET: /wallet/synchronize

Rescans the blockchain for data. Errors: 201:Wallet does not exist.


/synchronize get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/wallet/synchronize"

polls


polls get

GET: /polls

Returns an array of all the polls created by your accounts. Errors: 201-Wallet does not exist.


polls get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/polls"

polls post

POST: /polls

Used to create a new poll. Returns the transaction in JSON when successful. Errors: 1 - Json error. 2 - Not enough balance. 3 - Not yet released. 102 - Invalid address. 105 - Invalid fee. 108 - Invalid name length. 109 - Invalid description length. 113 - Invalid options length. 114 - Invalid option length. 201 - Wallet does not exist. 202 - Address does not exist in wallet. 203 - Wallet is locked. 404 - Name must be lowercase. 502 - Poll already exists. 503 - Duplicate option.


polls post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/polls" \
	-d @request_body

REQUEST BODY

{
  "creator": "<creatorAddress>",
  "name": "<name>",
  "description": "<description>",
  "options": [
    "<optionOne>",
    "<optionTwo>"
  ],
  "fee": "<fee>"
}

Returns an array of all the polls owned by a specific address in your wallet. Errors: 102 - Invalid address. 201 - Wallet does not exist. 202 - Address does not exist in wallet


/network get

GET: /polls/network

Returns an array of all the polls. For performance this array only contains the names of the polls and not the details.


/network get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/polls/network"


/vote/{name} post

POST: /polls/vote/{name}

Used to vote on a poll with the given name. Returns the transaction in JSON when successful. Errors: 1 - Json error. 2 - Not enough balance. 3 - Not yet released. 102 - Invalid address. 105 - Invalid fee. 108 - Invalid name length. 114 - Invalid option length. 201 - Wallet does not exist. 202 - Address does not exist in wallet. 203 - Wallet is locked. 404 - Name must be lowercase. 501 - Poll does not exist. 504 - Polloption does not exist. 505 - Already voted for that option.


URI Parameters

name

PropertyValue
requiredtrue
typestring

/vote/{name} post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/polls/vote/{name}" \
	-d @request_body

REQUEST BODY

{
  "voter": "<voterAddress>",
  "option": "<optionOne>",
  "fee": "<fee>"
}

peers


peers get

GET: /peers

Returns an array of all the IP's of the peers to which the application is currently connected.


peers get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/peers"


/detail get

GET: /peers/detail

Returns an array of all connected peer objects containing each peer's IP, height, version, ping time, onlineTime, findingTime, PingCounter, lastWhite time connection, lastGray time connection and status


/detail get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/peers/detail"

Returns all available information for peer with given ip. Errors: 123 - invalid network address.


/best get

GET: /peers/detail/best

Returns an array of the best known nodes.


/best get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/peers/detail/best"


/known get

GET: /peers/detail/known

Returns an array of all known peers.


/known get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/peers/detail/known"

/known delete

DELETE: /peers/detail/known

Forget all known peers with all statistics.


/known delete

CURL EXAMPLE

curl -X DELETE "http://127.0.0.1:9048/peers/detail/known"


/preset get

GET: /peers/detail/preset

Returns an array of all preset peers. From settings.json, peers.json, Internet, -peers=


/preset get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/peers/detail/preset"

blog


blog get

GET: /blog

Equivalent to blog/posts/ERA


blog get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blog"


/posts/{blogname} get

GET: /blog/posts/{blogname}

List posts to a blog by transaction signature. Ifis omitted, ERA is provided. Errors: 401 -Name does not exist. 902 - Blog disabled.


URI Parameters

blogname

PropertyValue
requiredtrue
typestring

/posts/{blogname} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blog/posts/{blogname}"


/post/{signature} get

GET: /blog/post/{signature}

Get the content of a blog entry specified by transaction signature. Errors: 101-Invalid signature. 311 - Transactions does not exist. 905 - Transaction with this signature contains no entries!


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/post/{signature} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blog/post/{signature}"


/entries/{blogname} get

GET: /blog/entries/{blogname}

Returns the content of the entries for the blog. Ifis omitted, ERA is provided. Errors 401 - Name does not exist. 902 - Blog disabled.


URI Parameters

blogname

PropertyValue
requiredtrue
typestring

/entries/{blogname} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blog/entries/{blogname}"


/limit/{limit} get

GET: /blog/entries/{blogname}/limit/{limit}

Returns the content of the specified number of blog entries. Errors: 401 - Name does not exist. 902 - Blog disabled.


URI Parameters

blogname

PropertyValue
requiredtrue
typestring

limit

PropertyValue
requiredtrue
typestring

/limit/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blog/entries/{blogname}/limit/{limit}"


/lastentry/{blogname} get

GET: /blog/lastentry/{blogname}

Returns the content of the last entry of the blog. Ifis omitted, ERA is provided. Errors: 401 - Name does not exist. 902 - Blog disabled.906 - This blog is empty.


URI Parameters

blogname

PropertyValue
requiredtrue
typestring

/lastentry/{blogname} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blog/lastentry/{blogname}"

blogpost


/{blogname} post

POST: /blogpost/{blogname}

Posts Posts to a blog., author, share, and delete are optional. Errors: 901 - Body empty. 105 - Invalid fee. 201 - Wallet no exists 203 - wallet locked 903 - name not owner. 102 - invalid address 202 - wallet adddress no exists 902 - blog disabled


URI Parameters

blogname

PropertyValue
requiredtrue
typestring

/{blogname} post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/blogpost/{blogname}" \
	-d @request_body

REQUEST BODY

{
  "fee": "<fee>",
  "creator": "<creator>",
  "author": "<author>",
  "title": "<title>",
  "body": "<body>",
  "share": "<share>",
  "delete": "<delete>"
}


/comment post

POST: /blogpost/comment

Leave a comment under the post with the given postid., author, are optional. Errors: 901 - Body empty. 105 - Invalid fee. 201 - Wallet no exists. 203 - wallet locked. 903 - name not owner. 102 - invalid address. 202 - wallet adddress no exists. 909 - commenting disabled


/comment post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/blogpost/comment" \
	-d @request_body

REQUEST BODY

{
  "fee": "<fee>",
  "creator": "<creator>",
  "author": "<author>",
  "title": "<title>",
  "body": "<body>",
  "postid": "<signature>"
}


/{signature} delete

DELETE: /blogpost/comment/{signature}

Deletes the comment with given signature. Errors: 910 - comment not existing. 911 - invalid comment owner. 201 - Wallet no exists. 203 - wallet locked.


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/{signature} delete

CURL EXAMPLE

curl -X DELETE "http://127.0.0.1:9048/blogpost/comment/{signature}"

transactions


transactions get

GET: /transactions

Returns an array of your accounts each with their 50 last transactions. Errors: 201 - Wallet does not exist.


transactions get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions"


/limit/{limit} get

GET: /transactions/limit/{limit}

Returns an array of your accounts each with theirlast transactions. Errors: 201 - Wallet does not exist.


URI Parameters

limit

PropertyValue
requiredtrue
typestring

/limit/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/limit/{limit}"


/address/{address} get

GET: /transactions/address/{address}

Returns an array of the last 50 transactions of a specific address in your wallet. Errors: 102 - Invalid address. 201 - Wallet does not exist. 202 - address does not exist in wallet


URI Parameters

address

PropertyValue
requiredtrue
typestring

/address/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/address/{address}"


/address/{address}/limit/{limit} get

GET: /transactions/address/{address}/limit/{limit}

Returns an array of the lasttransactions of a specific address in your wallet. Errors: 102 - Invalid address. 201 - Wallet does not exist. 202 - address does not exist in wallet


URI Parameters

address

PropertyValue
requiredtrue
typestring

limit

PropertyValue
requiredtrue
typestring

/address/{address}/limit/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/address/{address}/limit/{limit}"


/address/{address}/type/{type}/limit/{limit} get

GET: /transactions/address/{address}/type/{type}/limit/{limit}

Returns an array of the lasttransactions of a specific address and type.


URI Parameters

address

PropertyValue
requiredtrue
typestring

type

PropertyValue
requiredtrue
typestring

limit

PropertyValue
requiredtrue
typestring

/address/{address}/type/{type}/limit/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/address/{address}/type/{type}/limit/{limit}"


/signature/{signature} get

GET: /transactions/signature/{signature}

Returns the transaction that matches the given signature. Errors: 101 - Invalid signature. 311 - Transaction does not exist.


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/signature/{signature} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/signature/{signature}"


/network get

GET: /transactions/network

Returns an array of all the unconfirmed transactions known to the client.


/network get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/network"


/unconfirmedof/{address} get

GET: /transactions/unconfirmedof/{address}

Returns an array of all the unconfirmed transactions of address known to the client.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/unconfirmedof/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/unconfirmedof/{address}"


/recipient/{address}/limit/{limit} get

GET: /transactions/recipient/{address}/limit/{limit}

Returns an array of the lasttransactions with a specific recipient.


URI Parameters

address

PropertyValue
requiredtrue
typestring

limit

PropertyValue
requiredtrue
typestring

/recipient/{address}/limit/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/recipient/{address}/limit/{limit}"


/sender/{address}/limit/{limit} get

GET: /transactions/sender/{address}/limit/{limit}

Returns an array of thetransactions with a specific sender.


URI Parameters

address

PropertyValue
requiredtrue
typestring

limit

PropertyValue
requiredtrue
typestring

/sender/{address}/limit/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/transactions/sender/{address}/limit/{limit}"


/scan post

POST: /transactions/scan

Returns all the transactions that match the filters. All filters are optional but please limit that amount of transactions or blocks to scan to avoid running into issues. Requests that don't specify a blocklimit <= 360 will be denied to remote users. Return the last block it scanned, the amount of blocks it scanned and the scanned transactions. Errors: 1 - Json error. 102 - Invalid address. 101 - Invalid signature. 301 - Block does not exist.


/scan post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/transactions/scan" \
	-d @request_body

REQUEST BODY

{
  "start": "<startBlockSign>",
  "blocklimit": "<amountBlocks>",
  "transactionlimit": "<amountTransactions>",
  "type": "<type>",
  "service": "<service>",
  "address": "<address>"
}


/find post

POST: /transactions/find

Returns an array of thetransactions from givenwith a specific params. Set parameter "count" to true to find out the number of transactions. Set parameter "desc" to true for reverse order. Parameter "service" means service of ArbitraryTransaction. "minHeight" and "maxHeight" means height of blocks. All params are optional, but must be specified at least one address field.\nErrors: 102 - Invalid address.


/find post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/transactions/find" \
	-d @request_body

REQUEST BODY

{
  "address": "<address>",
  "sender": "<sender>",
  "recipient": "<recipient>",
  "type": "<type>",
  "service": "<service>",
  "offset": "<offset>",
  "limit": "<limit>",
  "minHeight": "<minHeight>",
  "maxHeight": "<maxHeight>",
  "desc": "<true/false>",
  "count": "<true/false>"
}

blocks


/blocks/addresses/{limit} get

GET: /blocks/blocks/addresses/{limit}

Returns an array of the LIMIT last blocks generated by your accounts. Errors: 201 - Wallet does not exist.


URI Parameters

limit

PropertyValue
requiredtrue
typestring

/blocks/addresses/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/addresses/{limit}"


/blocks/address/{address}/{limit} get

GET: /blocks/blocks/address/{address}/{limit}

Returns an array of the LIMIT last blocks generated by a specific address in your wallet. Errors: 102 - Invalid address. 201 - Wallet does not exist. 202 - Address does not exist in wallet.


URI Parameters

address

PropertyValue
requiredtrue
typestring

limit

PropertyValue
requiredtrue
typestring

/blocks/address/{address}/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/address/{address}/{limit}"


/blocks/{signature} get

GET: /blocks/blocks/{signature}

Returns the block that matches the given signature. Errors: 101 - Invalid signature. 301 - Block does not exist.


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/blocks/{signature} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/{signature}"


/blocks/first get

GET: /blocks/blocks/first

Returns the genesis block.


/blocks/first get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/first"


/blocks/last get

GET: /blocks/blocks/last

Returns the last valid block.


/blocks/last get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/last"


/blocks/child/{signature} get

GET: /blocks/blocks/child/{signature}

Returns the child block of the block that matches the given signature. Errors: 101 - Invalid signature. 301 - Block does not exist.


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/blocks/child/{signature} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/child/{signature}"


/blocks/generatingbalance get

GET: /blocks/blocks/generatingbalance

Calculates the generating balance of the block that will follow the last block.


/blocks/generatingbalance get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/generatingbalance"


/blocks/generatingbalance/{signature} get

GET: /blocks/blocks/generatingbalance/{signature}

Calculates the generating balance of the block that will follow the block that matches the signature. Errors: 101 - Invalid signature. 301 - Block does not exist.


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/blocks/generatingbalance/{signature} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/generatingbalance/{signature}"


/blocks/time get

GET: /blocks/blocks/time

Calculates the time it should take for the network to generate the next block.


/blocks/time get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/time"


/blocks/time/{generatingbalance} get

GET: /blocks/blocks/time/{generatingbalance}

Calculates the time it should take for the network to generate blocks when the current generating balance in the network is the specified generating balance.


URI Parameters

generatingbalance

PropertyValue
requiredtrue
typestring

/blocks/time/{generatingbalance} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/time/{generatingbalance}"


/blocks/height get

GET: /blocks/blocks/height

Returns the block height of the last block.


/blocks/height get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/height"


/blocks/height/{signature} get

GET: /blocks/blocks/height/{signature}

Returns the block height of the block that matches the given signature. Errors: 101 - Invalid signature. 301 - Block does not exist.


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/blocks/height/{signature} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/height/{signature}"


/blocks/headers/{signature} get

GET: /blocks/blocks/headers/{signature}

Returns the list oof block headers - for test networ response in controller.Controller.onMessage(GET_SIGNATURES_TYPE). Errors: 101 - Invalid signature. 301 - Block does not exist.


URI Parameters

signature

PropertyValue
requiredtrue
typestring

/blocks/headers/{signature} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/headers/{signature}"


/blocks/byheight/{height} get

GET: /blocks/blocks/byheight/{height}

Returns the block whith given height. Errors: 301 - Block does not exist.


URI Parameters

height

PropertyValue
requiredtrue
typestring

/blocks/byheight/{height} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/byheight/{height}"


/blocks/fromheight/{height} get

GET: /blocks/blocks/fromheight/{height}

Returns the block from given height. Errors: 301 - Block does not exist.


URI Parameters

height

PropertyValue
requiredtrue
typestring

/blocks/fromheight/{height} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/blocks/blocks/fromheight/{height}"

addresses


addresses get

GET: /addresses

Returns an array of all the addresses in your wallet. Errors: 201 - Wallet does not exist.


addresses get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses"

addresses post

POST: /addresses

Imports the given 32-byte long base58-encoded account seed. Returns the address when successfully imported. Errors: 103 - Invalid seed. 201 - Wallet does not exist. 203 - Wallet is locked.


Query Parameters

addressSeed

PropertyValue
requiredtrue
typestring

addresses post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/addresses" \
	-d @request_body

addresses delete

DELETE: /addresses

Deletes the given address. Returns true/false. Errors: 102 - Invalid address. 201 - Wallet does not exist. 203 - Wallet is locked.


Query Parameters

address

PropertyValue
requiredtrue
typestring

addresses delete

CURL EXAMPLE

curl -X DELETE "http://127.0.0.1:9048/addresses"


/validate/{address} get

GET: /addresses/validate/{address}

Validates the given address. Returns true/false.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/validate/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/validate/{address}"


/seed/{address} get

GET: /addresses/seed/{address}

Returns the 32-byte long base58-encoded account seed of the given address. Errors: 102 - Invalid address. 201 - Wallet does not exist. 202 - Address does not exist in wallet. 203 - Wallet is locked.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/seed/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/seed/{address}"


/publickey/{address} get

GET: /addresses/publickey/{address}

Returns the 32-byte long base58-encoded account publickey of the given address. Errors: 102 - Invalid address.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/publickey/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/publickey/{address}"


/new get

GET: /addresses/new

Generates a new account and returns the newly generated address./nErrors: /n201 - Wallet does not exist. /n203 - Wallet is locked.


/new get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/new"


/generatingbalance/{address} get

GET: /addresses/generatingbalance/{address}

Return the generating balance of the given address.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/generatingbalance/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/generatingbalance/{address}"


/balance/{address} get

GET: /addresses/balance/{address}

Returns the confirmed balance of the given address. Errors: 102 - Invalid address.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/balance/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/balance/{address}"


/balance/{address}/{confirmation} get

GET: /addresses/balance/{address}/{confirmation}

Calculates the balance of the given address after the given confirmations. Errors: 102 - Invalid address.


URI Parameters

address

PropertyValue
requiredtrue
typestring

confirmation

PropertyValue
requiredtrue
typestring

/balance/{address}/{confirmation} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/balance/{address}/{confirmation}"


/assetbalance/{key}/{address} get

GET: /addresses/assetbalance/{key}/{address}

Returns the confirmed balance of the given address for the given asset key. Errors: 102 - Invalid address. 601 - Invalid asset id.


URI Parameters

key

PropertyValue
requiredtrue
typestring

address

PropertyValue
requiredtrue
typestring

/assetbalance/{key}/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/assetbalance/{key}/{address}"


/sign/{address} post

POST: /addresses/sign/{address}

Signs the given message using the given address. Errors: 102 - Invalid address. 201 - Wallet does not exist. 202 - Address does not exist in wallet. 203 - Wallet is locked.


URI Parameters

address

PropertyValue
requiredtrue
typestring

Query Parameters

message

PropertyValue
requiredtrue
typestring

/sign/{address} post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/addresses/sign/{address}" \
	-d @request_body


/verify/{address} post

POST: /addresses/verify/{address}

Verifies if the given message was signed by the given address. Returns true/false. Errors: 101 - Invalid signature. 102 - Invalid address. 112 - Invalid public key.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/verify/{address} post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/addresses/verify/{address}" \
	-d @request_body

REQUEST BODY

{
  "message": "<message>",
  "publickey": "<publickey>",
  "signature": "<signature>"
}


/assets/{address} get

GET: /addresses/assets/{address}

Returns the list of assets for this address with balances. Errors: 102 - Invalid address.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/assets/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/assets/{address}"


/addresses/lastreference/{address} get

GET: /addresses/addresses/lastreference/{address}

Returns the 64-byte long base58-encoded signature of last transaction where the address is delivered as creator. Or the first incoming transaction. Returns "false" if there is no transactions.\nErrors: 102 - Invalid address.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/addresses/lastreference/{address} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/addresses/lastreference/{address}"


/lastreference/{address}/unconfirmed get

GET: /addresses/lastreference/{address}/unconfirmed

Returns the 64-byte long base58-encoded signature of last transaction including unconfirmed where the address is delivered as creator. Or the first incoming transaction. Returns "false" if there is no transactions.\nErrors: 102 - Invalid address.


URI Parameters

address

PropertyValue
requiredtrue
typestring

/lastreference/{address}/unconfirmed get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/addresses/lastreference/{address}/unconfirmed"

at


at get

GET: /at

Returns an array of all the Automated Transactions accounts.


at get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/at"

at post

POST: /at

Used to create a new AT account. Returns the transaction in JSON when successful.


at post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/at" \
	-d @request_body

REQUEST BODY

{
  "creator": "<creatorAddress>",
  "name": "<name>",
  "description": "<description>",
  "type": "<type>",
  "tags": "<tags>",
  "fee": "<fee>",
  "quantity": "<quantity>",
  "code": "<code>",
  "data": "<dataHex>",
  "dpages": "<dpages>",
  "cspages": "<cspages>",
  "uspages": "<uspages>"
}


/id/{id} get

GET: /at/id/{id}

Return details about AT account with the given assess.


URI Parameters

id

PropertyValue
requiredtrue
typestring

/id/{id} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/at/id/{id}"


/transactions/id/{sender} get

GET: /at/transactions/id/{sender}

Returns an array of all the AT transactions with the given sender.


URI Parameters

sender

PropertyValue
requiredtrue
typestring

/transactions/id/{sender} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/at/transactions/id/{sender}"


/creator/{creator} get

GET: /at/creator/{creator}

Returns an array of all the AT transactions with the given creator.


URI Parameters

creator

PropertyValue
requiredtrue
typestring

/creator/{creator} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/at/creator/{creator}"


/type/{type} get

GET: /at/type/{type}

Returns an array of AT accounts with the given type.


URI Parameters

type

PropertyValue
requiredtrue
typestring

/type/{type} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/at/type/{type}"


/transactions/recipient/{recipient} get

GET: /at/transactions/recipient/{recipient}

Returns an array of all the AT transactions with the given recipient.


URI Parameters

recipient

PropertyValue
requiredtrue
typestring

/transactions/recipient/{recipient} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/at/transactions/recipient/{recipient}"


/limit/{limit} get

GET: /at/limit/{limit}

Returns an array of AT accounts with creationBlock more then given.


URI Parameters

limit

PropertyValue
requiredtrue
typestring

/limit/{limit} get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/at/limit/{limit}"

core


/stop get

GET: /core/stop

Will stop the application. This command might not be able to return a http OK message.


/stop get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/core/stop"


/status get

GET: /core/status

Returns the status of the application. 0 - No connections. 1 - Synchronizing 2 - OK


/status get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/core/status"


/status/forging get

GET: /core/status/forging

Returns the status of the forging process. 0 - Forging disabled. 1 - Forging enabled 2 - Forging


/status/forging get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/core/status/forging"


/isuptodate get

GET: /core/isuptodate

Shows if the application is synchronized with the network.


/isuptodate get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/core/isuptodate"


/settings get

GET: /core/settings

Shows settings.


/settings get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/core/settings"


/version get

GET: /core/version

Returns the version and buildtime of the running client.


/version get

CURL EXAMPLE

curl -X GET "http://127.0.0.1:9048/core/version"

calcfee


/arbitrarytransactions post

POST: /calcfee/arbitrarytransactions

Calculates recommended fee and the length of the transaction for arbitrary transactions.


/arbitrarytransactions post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/calcfee/arbitrarytransactions" \
	-d @request_body

REQUEST BODY

{
  "data": "<base58data>"
}


/namereg post

POST: /calcfee/namereg

Calculates recommended fee and the length of the transaction for name registration.


/namereg post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/calcfee/namereg" \
	-d @request_body

REQUEST BODY

<value>


/nameupdate post

POST: /calcfee/nameupdate

Calculates recommended fee and the length of the transaction for update name.


/nameupdate post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/calcfee/nameupdate" \
	-d @request_body

REQUEST BODY

{
  "name": "<name>",
  "newvalue": "<value>"
}


/blogpost post

POST: /calcfee/blogpost

Calculates recommended fee and the length of the transaction for blogpost.


/blogpost post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/calcfee/blogpost" \
	-d @request_body

REQUEST BODY

{
  "blogname": "<blogname>",
  "author": "<author>",
  "title": "<title>",
  "body": "<body>"
}

payment


payment post

POST: /payment

Send a new payment using the given data. Returns the transaction in JSON when successful. If asset is omitted, 2 is provided (default commission asset). Errors: 1 - Json error. 104 - Invalid amount. 105 - Invalid fee. 106 - Invalid sender. 107 - Invalid recipient. 201 - Wallet does not exist. 203 - Wallet is locked


payment post

CURL EXAMPLE

curl -X POST "http://127.0.0.1:9048/payment" \
	-d @request_body

REQUEST BODY

{
  "asset": "<assetId>",
  "amount": "<amount>",
  "fee": "<fee>",
  "sender": "<senderAddress>",
  "recipient": "<recipient>"
}