ARK - Point. Click. Blockchain.

The ARK Library

Welcome to the ARK Library. You'll find comprehensive guides and documentation to help you start working with ark as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Community Discussions
 
Suggest Edits

Retrieve an account

 
gethttps://node1.arknet.cloud/api/accounts
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "account": {
        "address": "D59NTfV92ca9QevUydvMiFMFdubbCaAVCV",
        "publicKey": "037d035f08b3bad0d5bb605232c7aa41555693c480044dbeb797270a44c339da5a",
        "secondPublicKey": null,
        "vote": "0284a88da69cc04439633217c6961d2800df0f7dff7f85b9803848ee02d0743f1d",
        "username": null,
        "balance": 1023145260990,
        "votebalance": 0
    },
    "success": true
}

Query Params

address
string

Unique address for the account.

 
Suggest Edits

Retrieve the balance of an account

 
gethttps://node1.arknet.cloud/api/accounts/getBalance
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').balance('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "balance": 1023145260990,
    "unconfirmedBalance": 1023145260990,
    "success": true
}

Query Params

address
string

Unique address for the account.

 
Suggest Edits

Retrieve the public key of an account

 
gethttps://node1.arknet.cloud/api/accounts/getPublicKey
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').publicKey('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "publicKey": "037d035f08b3bad0d5bb605232c7aa41555693c480044dbeb797270a44c339da5a",
    "success": true
}

Query Params

address
string

Unique address for the account.

 
Suggest Edits

Retrieve the delegate registration fee

 
gethttps://node1.arknet.cloud/api/accounts/delegates/fee
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').delegateFee()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "fee": 2500000000,
    "success": true
}
 
Suggest Edits

Retrieve the total count of accounts

 
gethttps://node1.arknet.cloud/api/accounts/count
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').count()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "count": 841,
    "success": true
}
 
Suggest Edits

Retrieve the voted delegate of an account

 
gethttps://node1.arknet.cloud/api/accounts/delegates
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').vote('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "delegates": [
        {
            "username": "bioly",
            "address": "DRkVSeW5e2zh9v7R5msdLc26fo8axFALGT",
            "publicKey": "0284a88da69cc04439633217c6961d2800df0f7dff7f85b9803848ee02d0743f1d",
            "vote": "13475943400000",
            "producedblocks": 0,
            "missedblocks": 0,
            "rate": 15,
            "approval": "0.10",
            "productivity": "0.00"
        }
    ],
    "success": true
}

Query Params

address
string

Unique address for the account.

 
Suggest Edits

List all accounts

 
gethttps://node1.arknet.cloud/api/accounts/getAllAccounts
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "wallets": [
        {
            "address": "D59NTfV92ca9QevUydvMiFMFdubbCaAVCV",
            "publicKey": "037d035f08b3bad0d5bb605232c7aa41555693c480044dbeb797270a44c339da5a",
            "secondPublicKey": null,
            "vote": "0284a88da69cc04439633217c6961d2800df0f7dff7f85b9803848ee02d0743f1d",
            "username": null,
            "balance": 1023145260990,
            "votebalance": 0
        }
    ],
    "success": true
}

Query Params

offset
int32

The offset of resources that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all top accounts

 
gethttps://node1.arknet.cloud/api/accounts/top
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('accounts').top()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "accounts": [
        {
            "address": "DGihocTkwDygiFvmg6aG8jThYTic47GzU9",
            "balance": 11499593462120632,
            "publicKey": "024c8247388a02ecd1de2a3e3fd5b7c61ecc2797fa3776599d558333ef1802d231"
        }
    ],
    "success": true
}

Query Params

offset
int32

The offset of records that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

Retrieve a block

 
gethttps://node1.arknet.cloud/api/blocks/get
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "block": {
        "id": "17667031254892018837",
        "version": 0,
        "timestamp": 32818936,
        "previousBlock": "17683512654394589083",
        "height": 3035603,
        "numberOfTransactions": 0,
        "totalAmount": 0,
        "totalFee": 0,
        "reward": 200000000,
        "payloadLength": 0,
        "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "generatorPublicKey": "02af5e6341efc14f4ba39a9ff65e151cc7304fc742ce7b2678d9aa446c555ee9c1",
        "blockSignature": "3045022100b128be0f76ed92be93cd8ef2bb64e199ab25ee66f72c75190e0f679d85b92f07022048f9c161e0e2055f7e80a663897b05ac6289b309acf9720f232565323c200afd",
        "confirmations": 8
    },
    "success": true
}

Query Params

id
string

Unique identifier for the block.

 
Suggest Edits

List all blocks

 
gethttps://node1.arknet.cloud/api/blocks
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "blocks": [
        {
            "id": "17667031254892018837",
            "version": 0,
            "timestamp": 32818936,
            "previousBlock": "17683512654394589083",
            "height": 3035603,
            "numberOfTransactions": 0,
            "totalAmount": 0,
            "totalFee": 0,
            "reward": 200000000,
            "payloadLength": 0,
            "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "generatorPublicKey": "02af5e6341efc14f4ba39a9ff65e151cc7304fc742ce7b2678d9aa446c555ee9c1",
            "blockSignature": "3045022100b128be0f76ed92be93cd8ef2bb64e199ab25ee66f72c75190e0f679d85b92f07022048f9c161e0e2055f7e80a663897b05ac6289b309acf9720f232565323c200afd",
            "confirmations": 0
        },
        {
            "id": "17683512654394589083",
            "version": 0,
            "timestamp": 32818928,
            "previousBlock": "13631091596497440274",
            "height": 3035602,
            "numberOfTransactions": 0,
            "totalAmount": 0,
            "totalFee": 0,
            "reward": 200000000,
            "payloadLength": 0,
            "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "generatorPublicKey": "03f264a6d2ebb62279313a6fd7fec4e2244785839b625a0b0c261e689ce5401d87",
            "blockSignature": "3044022076b8af9b9b31fb9f96761a00afb28b8fd95c6815d53a10e906dc781a8ec4aa4102205d7125b7923966e7f8f2aa2a58c40006cf792aa6a3caee1cd80ddcad0b000e18",
            "confirmations": 1
        }
    ],
    "success": true
}

Query Params

offset
int32

The offset of resources that will be returned.

limit
int32

The number of resources per page.

orderBy
string

The column by which the resources will be sorted.

generatorPublicKey
string

The public key by which the resources will be filtered.

totalAmount
int32

The total amount by which the resources will be filtered.

totalFee
int32

The total fee by which the resources will be filtered.

reward
int32

The reward by which the resources will be filtered.

previousBlock
int32

The previous block id by which the resources will be filtered.

height
int32

The height by which the resources will be filtered.

 
Suggest Edits

Retrieve the epoch of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getEpoch
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').epoch()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "epoch": "2017-03-21T13:00:00.000Z",
    "success": true
}
 
Suggest Edits

Retrieve the height of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getHeight
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').height()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "height": 3035616,
    "id": "4635377835812759465",
    "success": true
}
 
Suggest Edits

Retrieve the nethash of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getNethash
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').nethash()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "nethash": "578e820911f24e039733b45e4882b73e301f813a0d2c31330dafda84534ffa23",
    "success": true
}
 
Suggest Edits

Retrieve a fee

 
gethttps://node1.arknet.cloud/api/blocks/getFee
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').fee('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "fee": 10000000,
    "success": true
}
 
Suggest Edits

List all fees of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getFees
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').fees()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Retrieve the milestone of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getMilestone
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').milestone()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "milestone": 1,
    "success": true
}
 
Suggest Edits

Retrieve the reward of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getReward
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').reward()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "reward": 200000000,
    "success": true
}
 
Suggest Edits

Retrieve the supply of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getSupply
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').supply()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "supply": 13092004200000000,
    "success": true
}
 
Suggest Edits

Retrieve the status of the blockchain

 
gethttps://node1.arknet.cloud/api/blocks/getStatus
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('blocks').status()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "epoch": "2017-03-21T13:00:00.000Z",
    "height": 3035628,
    "fee": 10000000,
    "milestone": 1,
    "nethash": "578e820911f24e039733b45e4882b73e301f813a0d2c31330dafda84534ffa23",
    "reward": 200000000,
    "supply": 13092005600000000,
    "success": true
}
 
Suggest Edits

Delegates

 
Suggest Edits

Retrieve a delegate

 
gethttps://node1.arknet.cloud/api/delegates/get
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('delegates').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "delegates": [
        {
            "username": "dark_jmc",
            "address": "D5PXQVeJmchVrZFHL7cALZK8mWWzjCaVfz",
            "publicKey": "02a9a0ac34a94f9d27fd9b4b56eb3c565a9a3f61e660f269775fb456f7f3301586",
            "vote": "02a9a0ac34a94f9d27fd9b4b56eb3c565a9a3f61e660f269775fb456f7f3301586"
        },
        {
            "username": "pimoussefrnl_node_3",
            "address": "D5gqHU5UkDrugaemW2NNFH4hDyvfW2TEix",
            "publicKey": "022289579cd6336d9b940576170c016aa95c3003d9ceb16dbdb67098d35f6219d8",
            "vote": null
        }
    ],
    "success": true
}

Query Params

publicKey
string

Unique public key for the delegate.

username
string

Unique username for the delegate.

 
Suggest Edits

Retrieve the total count of delegates

 
gethttps://node1.arknet.cloud/api/delegates/count
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('delegates').count()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "count": 197,
    "success": true
}
 
Suggest Edits

Retrieve the delegate registration fee

 
gethttps://node1.arknet.cloud/api/delegates/fee
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('delegates').fee()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "delegate": {
        "username": "boldninja",
        "address": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
        "publicKey": "022cca9529ec97a772156c152a00aad155ee6708243e65c9d211a589cb5d43234d",
        "vote": "0257b7724e97cd832e0c28533a86da5220656f9b5122141daab20e8526decce01f"
    },
    "success": true
}
 
Suggest Edits

Retrieve the total forged of a delegate

 
gethttps://node1.arknet.cloud/api/delegates/forging/getForgedByAccount
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('delegates').forged('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "fees": 66670000000,
    "rewards": 11968200000000,
    "forged": 12034870000000,
    "success": true
}

Query Params

generatorPublicKey
string
required

Unique public key for the delegate.

 
Suggest Edits

List all voters of a delegate

 
gethttps://node1.arknet.cloud/api/delegates/voters
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('delegates').voters('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "accounts": [
        {
            "username": null,
            "address": "D5mbS6mpP5UheuciNscpDLgC127kYjRtkK",
            "publicKey": "03f7e0b1ab14985990416f72ed0b206c20b9efa35156e4528c8ff749fa0eea5d5a",
            "balance": 400000000
        }
    ],
    "success": true
}

Query Params

publicKey
string
required

Unique public key for the delegate.

 
Suggest Edits

List all delegates

 
gethttps://node1.arknet.cloud/api/delegates
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('delegates').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "delegates": [
        {
            "username": "dark_jmc",
            "address": "D5PXQVeJmchVrZFHL7cALZK8mWWzjCaVfz",
            "publicKey": "02a9a0ac34a94f9d27fd9b4b56eb3c565a9a3f61e660f269775fb456f7f3301586",
            "vote": "02a9a0ac34a94f9d27fd9b4b56eb3c565a9a3f61e660f269775fb456f7f3301586"
        }
    ],
    "success": true
}

Query Params

offset
int32

The offset of resources that will be returned.

limit
int32

The number of resources per page.

orderBy
string

The column by which the resources will be sorted.

 
Suggest Edits

Search all delegates

 
gethttps://node1.arknet.cloud/api/delegates/search
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('delegates').search({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

offset
int32

The offset of records that will be returned.

limit
int32

The number of resources per page.

q
string
required

The search query by which the resources will be filtered.

 
Suggest Edits

Retrieve the status

 
gethttps://node1.arknet.cloud/api/loader/status
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('loader').status()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "loaded": false,
    "now": 3034441,
    "blocksCount": -26,
    "success": true
}
 
Suggest Edits

Retrieve the syncing status

 
gethttps://node1.arknet.cloud/api/loader/status/sync
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('loader').syncing()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "syncing": true,
    "blocks": -31,
    "height": 3034446,
    "id": "16245805386023811986",
    "success": true
}
 
Suggest Edits

Retrieve the configuration

 
gethttps://node1.arknet.cloud/api/loader/autoconfigure
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('loader').configuration()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "network": {
        "nethash": "578e820911f24e039733b45e4882b73e301f813a0d2c31330dafda84534ffa23",
        "token": "DARK",
        "symbol": "DѦ",
        "explorer": "https://dexplorer.ark.io",
        "version": 30,
      	"ports": {
					"@arkecosystem/core-p2p": 4000,
          "@arkecosystem/core-api": 4003,
          "@arkecosystem/core-graphql": 4005,
          "@arkecosystem/core-json-rpc": 8080
        },
        "feeStatistics": [
          {
            "type": 0,
            "fees": {
              "minFee": 268421,
              "maxFee": 597781,
              "avgFee": 404591
            }
          }
        ]
    },
    "success": true
}
 
Suggest Edits

Retrieve a peer

 
gethttps://node1.arknet.cloud/api/peers/get
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('peers').get('127.0.0.1')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "peer": {
        "ip": "145.239.88.101",
        "port": 4002,
        "version": "1.1.1",
        "status": "OK",
        "os": "linux4.4.0-109-generic",
        "delay": 254
    },
    "success": true
}

Query Params

ip
string
required

IP address for the peer.

port
int32
required

Public port for the peer.

 
Suggest Edits

List all peers

 
gethttps://node1.arknet.cloud/api/peers
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('peers').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "peers": [
        {
            "ip": "62.113.246.106",
            "port": 4002,
            "version": "1.1.1",
            "height": 3035375,
            "status": "OK",
            "os": "linux2.6.32-042stab127.2",
            "delay": 109
        }
    ],
    "success": true
}

Query Params

offset
int32

The offset of resources that will be returned.

limit
int32

The number of resources per page.

port
int32

The port by which the resources will be filtered.

status
string

The status by which the resources will be filtered.

os
string

The operating system by which the resources will be filtered.

version
string

The node version by which the resources will be filtered.

orderBy
string

The column by which the resources will be sorted.

 
Suggest Edits

Retrieve the core version

 
gethttps://node1.arknet.cloud/api/peers/version
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('peers').version()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "version": "1.0.0",
    "success": true
}
 
Suggest Edits

Signatures

 
Suggest Edits

Retrieve the signature registration fee

 
gethttps://node1.arknet.cloud/api/signatures/fee
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('signatures').fee()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "fee": 500000000,
    "success": true
}
 
Suggest Edits

Transactions

 
Suggest Edits

Retrieve a transaction

 
gethttps://node1.arknet.cloud/api/transactions/get
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('transactions').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "transaction": {
        "id": "5c6ce775447a5acd22050d72e2615392494953bb1fb6287e9ffb3c33eaeb79aa",
        "blockid": "4271682877946294396",
        "type": 0,
        "timestamp": 32794053,
        "amount": 32106400000,
        "fee": 10000000,
        "recipientId": "DQnQNoJuNCvpjYhxL7fsnGepHBqrumgsyP",
        "senderId": "DDiTHZ4RETZhGxcyAi1VruCXZKxBFqXMeh",
        "senderPublicKey": "027742333b7f06acef9d3a7b3a9a924dbe6b9ddd3dd164c808546cacd49f6e8682",
        "signature": "3044022047c39f6f45a46a87f91ca867f9551dbebf0035adcfcbdc1370222c7a1517fc0002206fb5ecc10460e0352a8b626a508e2fcc76e39e490b0a2581dd772ebc8079696e",
        "confirmations": 2279
    },
    "success": true
}

Query Params

id
string
required

Unique identifier for the transaction.

 
Suggest Edits

List all transactions

 
gethttps://node1.arknet.cloud/api/transactions
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('transactions').all({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "transactions": [
        {
            "id": "5c6ce775447a5acd22050d72e2615392494953bb1fb6287e9ffb3c33eaeb79aa",
            "blockid": "4271682877946294396",
            "type": 0,
            "timestamp": 32794053,
            "amount": 32106400000,
            "fee": 10000000,
            "recipientId": "DQnQNoJuNCvpjYhxL7fsnGepHBqrumgsyP",
            "senderId": "DDiTHZ4RETZhGxcyAi1VruCXZKxBFqXMeh",
            "senderPublicKey": "027742333b7f06acef9d3a7b3a9a924dbe6b9ddd3dd164c808546cacd49f6e8682",
            "signature": "3044022047c39f6f45a46a87f91ca867f9551dbebf0035adcfcbdc1370222c7a1517fc0002206fb5ecc10460e0352a8b626a508e2fcc76e39e490b0a2581dd772ebc8079696e",
            "confirmations": 2279
        }
    ],
    "success": true
}

Query Params

offset
int32

The offset of resources that will be returned.

limit
int32

The number of resources per page.

blockId
string

Unique identifier for the block.

type
int32

Unique identifier for the transaction type.

orderBy
string

The column by which the resources will be sorted.

senderPublicKey
string

The sender public key by which the resources will be filtered.

vendorField
string

The vendor field by which the resources will be filtered.

ownerPublicKey
string

The owner public key by which the resources will be filtered.

ownerAddress
string

The owner address by which the resources will be filtered.

senderId
string

The sender address by which the resources will be filtered.

recipientId
string

The recipient address by which the resources will be filtered.

amount
int32

The amount by which the resources will be filtered.

fee
int32

The fee by which the resources will be filtered.

 
Suggest Edits

Retrieve an unconfirmed transaction

 
gethttps://node1.arknet.cloud/api/transactions/unconfirmed/get
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('transactions').getUnconfirmed('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

id
string

Unique identifier for the transaction.

 
Suggest Edits

List all unconfirmed transactions

 
gethttps://node1.arknet.cloud/api/transactions/unconfirmed
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(1)
  
  const response = await client.api('transactions').allUnconfirmed({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

senderPublicKey
string

The sender public key by which the resources will be filtered.

address
string

The address by which the resources will be filtered.

 
Suggest Edits

Retrieve a block

 
gethttps://node1.arknet.cloud/api//blocks/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('blocks').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "id": "58328125061111756",
        "version": 0,
        "height": 3035362,
        "previous": "3741191868092856237",
        "forged": {
            "reward": 200000000,
            "fee": 0,
            "total": 200000000
        },
        "payload": {
            "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "length": 0
        },
        "generator": {
            "username": "genesis_6",
            "address": "D5e2FzTPqdEHridjzpFZCCVyepAu6Vpmk4",
            "publicKey": "023e577a7b3362e0aba70e6911d230e86d729b4cb640f0e0b25637b812a3e38b53"
        },
        "signature": "3044022047aeb0c9cfbb5709aba4c177009bfdc7804ef597073fb9ca6cb614d7e3d1af2d02207234119d02ca26600ece045c59266945081b4c8237370576aaad7c61a09fe0ad",
        "transactions": 0,
        "timestamp": {
            "epoch": 32816544,
            "unix": 1522917744,
            "human": "2018-04-05T08:42:24Z"
        }
    }
}

Path Params

id
string
required

Unique identifier for the block.

 
Suggest Edits

List all blocks

 
gethttps://node1.arknet.cloud/api//blocks
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('blocks').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 1517682,
        "totalCount": 3035363,
        "next": "/v2/blocks?limit=2&page=2",
        "previous": null,
        "self": "/v2/blocks?limit=2&page=1",
        "first": "/v2/blocks?limit=2&page=1",
        "last": "/v2/blocks?limit=2&page=1517682"
    },
    "data": [
        {
            "id": "6402736103893238690",
            "version": 0,
            "height": 3035363,
            "previous": "58328125061111756",
            "forged": {
                "reward": 200000000,
                "fee": 0,
                "total": 200000000
            },
            "payload": {
                "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
                "length": 0
            },
            "generator": {
                "username": "shawmishrak",
                "address": "D7P41dV7s259L3P7BVPNyqExqNDC7vdfx9",
                "publicKey": "030fa94238eb63db0247a9bd6a3fd810f690b449ee9ce4eb654b94b22875a9a612"
            },
            "signature": "304402204d0dbeb4e71a99a0f128a3480350014f0a9f250818dae908edd15bce99f49be00220257bf240c5d8578e9ffe144e7dbf0c2259d34e6571e6a83402edc01daec6228e",
            "transactions": 0,
            "timestamp": {
                "epoch": 32816552,
                "unix": 1522917752,
                "human": "2018-04-05T08:42:32Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all transactions of a block

 
gethttps://node1.arknet.cloud/api//blocks/id/transactions
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('blocks').transactions('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 1,
        "pageCount": 1,
        "totalCount": 1,
        "next": null,
        "previous": null,
        "self": "/v2/blocks/14126007750611341900/transactions?page=1",
        "first": "/v2/blocks/14126007750611341900/transactions?page=1",
        "last": "/v2/blocks/14126007750611341900/transactions?page=1"
    },
    "data": [
        {
            "id": "57415c61e6e7f10a6f9820d5124b3916f3c3a036b360f4802f0eb484f86f3369",
            "blockId": "14126007750611341900",
            "type": 0,
            "amount": 1000000000000000,
            "fee": 10000000,
            "sender": "DGihocTkwDygiFvmg6aG8jThYTic47GzU9",
            "recipient": "DRac35wghMcmUSe5jDMLBDLWkVVjyKZFxK",
            "signature": "3045022100878335a71ab6769f3c1e2895041ad24d6c58cdcfe1151c639e65289e5287b0a8022010800bcfdc3223a9c59a6b014e8adf72f1c34df8a46afe655b021930b03e214e",
            "vendorField": "yo",
            "confirmations": 3034848,
            "timestamp": {
                "epoch": 3909196,
                "unix": 1494010396,
                "human": "2017-05-05T18:53:16Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

Search all blocks

 
posthttps://node1.arknet.cloud/api//blocks/search
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('blocks').search({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 1,
        "pageCount": 1,
        "totalCount": 1,
        "next": null,
        "previous": null,
        "self": "/v2/blocks/14126007750611341900/transactions/search?page=1",
        "first": "/v2/blocks/14126007750611341900/transactions/search?page=1",
        "last": "/v2/blocks/14126007750611341900/transactions/search?page=1"
    },
    "data": [
        {
            "id": "57415c61e6e7f10a6f9820d5124b3916f3c3a036b360f4802f0eb484f86f3369",
            "blockId": "14126007750611341900",
            "type": 0,
            "amount": 1000000000000000,
            "fee": 10000000,
            "sender": "DGihocTkwDygiFvmg6aG8jThYTic47GzU9",
            "recipient": "DRac35wghMcmUSe5jDMLBDLWkVVjyKZFxK",
            "signature": "3045022100878335a71ab6769f3c1e2895041ad24d6c58cdcfe1151c639e65289e5287b0a8022010800bcfdc3223a9c59a6b014e8adf72f1c34df8a46afe655b021930b03e214e",
            "vendorField": "yo",
            "confirmations": 3034848,
            "timestamp": {
                "epoch": 3909196,
                "unix": 1494010396,
                "human": "2017-05-05T18:53:16Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

Body Params

id
string
version
string
previousBlock
string
payloadHash
string
generatorPublicKey
string
blockSignature
string
timestamp
object
 
timestamp.from
integer
timestamp.to
integer
height
object
 
height.from
integer
height.to
integer
numberOfTransactions
object
 
numberOfTransactions.from
integer
numberOfTransactions.to
integer
totalAmount
object
 
totalAmount.from
integer
totalAmount.to
integer
totalFee
object
 
totalFee.from
integer
totalFee.to
integer
reward
object
 
reward.from
integer
reward.to
integer
payloadLength
object
 
payloadLength.from
integer
payloadLength.to
integer
 
Suggest Edits

Delegates

 
Suggest Edits

Retrieve a delegate

 
gethttps://node1.arknet.cloud/api//delegates/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('delegates').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "username": "boldninja",
        "address": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
        "publicKey": "022cca9529ec97a772156c152a00aad155ee6708243e65c9d211a589cb5d43234d",
        "votes": 0,
        "blocks": {
            "produced": 0,
            "missed": 0,
            "last": {
                "id": "10652480998435361357",
                "timestamp": {
                    "epoch": 32816112,
                    "unix": 1522917312,
                    "human": "2018-04-05T08:35:12Z"
                }
            }
        },
        "production": {
            "approval": "0.10",
            "productivity": "0.00"
        }
    }
}

Path Params

id
string
required

Unique identifier for the delegate. (username, address or public key)

 
Suggest Edits

List all delegates

 
gethttps://node1.arknet.cloud/api//delegates
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('delegates').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 99,
        "totalCount": 197,
        "next": "/v2/delegates?page=2",
        "previous": null,
        "self": "/v2/delegates?page=1",
        "first": "/v2/delegates?page=1",
        "last": "/v2/delegates?page=99"
    },
    "data": [
        {
            "username": "dark_jmc",
            "address": "D5PXQVeJmchVrZFHL7cALZK8mWWzjCaVfz",
            "publicKey": "02a9a0ac34a94f9d27fd9b4b56eb3c565a9a3f61e660f269775fb456f7f3301586",
            "votes": 0,
            "blocks": {
                "produced": 0,
                "missed": 0,
                "last": {
                    "id": "12383884455448354193",
                    "timestamp": {
                        "epoch": 31784600,
                        "unix": 1521885800,
                        "human": "2018-03-24T10:03:20Z"
                    }
                }
            },
            "production": {
                "approval": "0.08",
                "productivity": "0.00"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all blocks of a delegate

 
gethttps://node1.arknet.cloud/api//delegates/id/blocks
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('delegates').blocks('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 29919,
        "totalCount": 59838,
        "next": "/v2/delegates/boldninja/blocks?page=2",
        "previous": null,
        "self": "/v2/delegates/boldninja/blocks?page=1",
        "first": "/v2/delegates/boldninja/blocks?page=1",
        "last": "/v2/delegates/boldninja/blocks?page=29919"
    },
    "data": [
        {
            "id": "10652480998435361357",
            "version": 0,
            "height": 3035318,
            "previous": "12548322724277171379",
            "forged": {
                "reward": 200000000,
                "fee": 0,
                "total": 200000000
            },
            "payload": {
                "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
                "length": 0
            },
            "generator": {
                "username": "boldninja",
                "address": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
                "publicKey": "022cca9529ec97a772156c152a00aad155ee6708243e65c9d211a589cb5d43234d"
            },
            "signature": "3044022034e754a3ff70adba6323517e1297c6a9f30176df2ac589661e9206fe60a203120220182c38da201fee20e803bb7725fe9618d6707547e6d7b757d4108f546934fe1c",
            "transactions": 0,
            "timestamp": {
                "epoch": 32816112,
                "unix": 1522917312,
                "human": "2018-04-05T08:35:12Z"
            }
        }
    ]
}

Path Params

id
string
required

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all voters of a delegate

 
gethttps://node1.arknet.cloud/api//delegates/id/voters
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('delegates').voters('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 10,
        "totalCount": 19,
        "next": "/v2/delegates/boldninja/voters?page=2",
        "previous": null,
        "self": "/v2/delegates/boldninja/voters?page=1",
        "first": "/v2/delegates/boldninja/voters?page=1",
        "last": "/v2/delegates/boldninja/voters?page=10"
    },
    "data": [
        {
            "address": "D5mbS6mpP5UheuciNscpDLgC127kYjRtkK",
            "publicKey": "03f7e0b1ab14985990416f72ed0b206c20b9efa35156e4528c8ff749fa0eea5d5a",
            "balance": 400000000,
            "isDelegate": false
        }
    ]
}

Path Params

id
string
required

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

Retrieve the status

 
gethttps://node1.arknet.cloud/api//node/status
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('node').status()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "synced": false,
        "now": 3034451,
        "blocksCount": -36
    }
}
 
Suggest Edits

Retrieve the syncing status

 
gethttps://node1.arknet.cloud/api//node/syncing
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('node').syncing()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "syncing": true,
        "blocks": -36,
        "height": 3034451,
        "id": "5444078994968869529"
    }
}
 
Suggest Edits

Retrieve the configuration

 
gethttps://node1.arknet.cloud/api//node/configuration
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('node').configuration()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "nethash": "578e820911f24e039733b45e4882b73e301f813a0d2c31330dafda84534ffa23",
        "token": "DARK",
        "symbol": "DѦ",
        "explorer": "https://dexplorer.ark.io",
        "version": 30,
      	"ports": {
          "@arkecosystem/core-p2p": 4000,
          "@arkecosystem/core-api": 4003,
          "@arkecosystem/core-graphql": 4005,
          "@arkecosystem/core-json-rpc": 8080
        },
        "feeStatistics": [
          {
            "type": 0,
            "fees": {
              "minFee": 268421,
              "maxFee": 597781,
              "avgFee": 404591
            }
          }
        ],
        "constants": {
            "height": 75600,
            "reward": 200000000,
            "activeDelegates": 51,
            "blocktime": 8,
            "block": {
                "version": 0,
                "maxTransactions": 50,
                "maxPayload": 2097152
            },
            "epoch": "2017-03-21T13:00:00.000Z",
            "fees": {
                "send": 10000000,
                "vote": 100000000,
                "secondsignature": 500000000,
                "delegate": 2500000000,
                "multisignature": 500000000
            }
        }
    }
}
 
Suggest Edits

Retrieve a peer

 
gethttps://node1.arknet.cloud/api//peers/ip
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('peers').get('127.0.0.1')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "ip": "167.114.29.55",
        "port": 4002,
        "version": "1.1.1",
        "status": "OK",
        "latency": 355
    }
}

Path Params

ip
string
required

Unique identifier for the delegate.

 
Suggest Edits

List all peers

 
gethttps://node1.arknet.cloud/api//peers
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('peers').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 1,
        "totalCount": 2,
        "next": null,
        "previous": null,
        "self": "/v2/peers?page=1",
        "first": "/v2/peers?page=1",
        "last": "/v2/peers?page=1"
    },
    "data": [
        {
            "ip": "167.114.29.53",
            "port": 4002,
            "version": "1.1.1",
            "status": "OK",
            "latency": 1390
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

Transactions

 
Suggest Edits

Create a transaction

 
posthttps://node1.arknet.cloud/api//transactions
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('transactions').create({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

transactions
array
 
Suggest Edits

Retrieve a transaction

 
gethttps://node1.arknet.cloud/api//transactions/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('transactions').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "id": "5c6ce775447a5acd22050d72e2615392494953bb1fb6287e9ffb3c33eaeb79aa",
        "blockId": "4271682877946294396",
        "type": 0,
        "amount": 32106400000,
        "fee": 10000000,
        "sender": "DDiTHZ4RETZhGxcyAi1VruCXZKxBFqXMeh",
        "recipient": "DQnQNoJuNCvpjYhxL7fsnGepHBqrumgsyP",
        "signature": "3044022047c39f6f45a46a87f91ca867f9551dbebf0035adcfcbdc1370222c7a1517fc0002206fb5ecc10460e0352a8b626a508e2fcc76e39e490b0a2581dd772ebc8079696e",
        "confirmations": 1928,
        "timestamp": {
            "epoch": 32794053,
            "unix": 1522895253,
            "human": "2018-04-05T02:27:33Z"
        }
    }
}

Path Params

id
string
required

Unique identifier for the transaction.

 
Suggest Edits

Retrieve an unconfirmed transaction

 
gethttps://node1.arknet.cloud/api//transactions/unconfirmed/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('transactions').getUnconfirmed('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique identifier for the transaction.

 
Suggest Edits

List all transactions

 
gethttps://node1.arknet.cloud/api//transactions
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('transactions').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 127430,
        "totalCount": 254860,
        "next": "/v2/transactions?page=2",
        "previous": null,
        "self": "/v2/transactions?page=1",
        "first": "/v2/transactions?page=1",
        "last": "/v2/transactions?page=127430"
    },
    "data": [
        {
            "id": "5c6ce775447a5acd22050d72e2615392494953bb1fb6287e9ffb3c33eaeb79aa",
            "blockId": "4271682877946294396",
            "type": 0,
            "amount": 32106400000,
            "fee": 10000000,
            "sender": "DDiTHZ4RETZhGxcyAi1VruCXZKxBFqXMeh",
            "recipient": "DQnQNoJuNCvpjYhxL7fsnGepHBqrumgsyP",
            "signature": "3044022047c39f6f45a46a87f91ca867f9551dbebf0035adcfcbdc1370222c7a1517fc0002206fb5ecc10460e0352a8b626a508e2fcc76e39e490b0a2581dd772ebc8079696e",
            "confirmations": 1924,
            "timestamp": {
                "epoch": 32794053,
                "unix": 1522895253,
                "human": "2018-04-05T02:27:33Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all unconfirmed transaction

 
gethttps://node1.arknet.cloud/api//transactions/unconfirmed
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('transactions').allUnconfirmed()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all transaction types

 
gethttps://node1.arknet.cloud/api//transactions/types
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('transactions').types()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "TRANSFER": 0,
        "SECOND_SIGNATURE": 1,
        "DELEGATE": 2,
        "VOTE": 3,
        "MULTI_SIGNATURE": 4,
        "IPFS": 5,
        "TIMELOCK_TRANSFER": 6,
        "MULTI_PAYMENT": 7,
        "DELEGATE_RESIGNATION": 8
    }
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

Search all transactions

 
posthttps://node1.arknet.cloud/api//transactions/search
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('transactions').search({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 127430,
        "totalCount": 254860,
        "next": "/v2/transactions/search?page=2",
        "previous": null,
        "self": "/v2/transactions/search?page=1",
        "first": "/v2/transactions/search?page=1",
        "last": "/v2/transactions/search?page=127430"
    },
    "data": [
        {
            "id": "5c6ce775447a5acd22050d72e2615392494953bb1fb6287e9ffb3c33eaeb79aa",
            "blockId": "4271682877946294396",
            "type": 0,
            "amount": 32106400000,
            "fee": 10000000,
            "sender": "DDiTHZ4RETZhGxcyAi1VruCXZKxBFqXMeh",
            "recipient": "DQnQNoJuNCvpjYhxL7fsnGepHBqrumgsyP",
            "signature": "3044022047c39f6f45a46a87f91ca867f9551dbebf0035adcfcbdc1370222c7a1517fc0002206fb5ecc10460e0352a8b626a508e2fcc76e39e490b0a2581dd772ebc8079696e",
            "confirmations": 1924,
            "timestamp": {
                "epoch": 32794053,
                "unix": 1522895253,
                "human": "2018-04-05T02:27:33Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

Body Params

id
string
blockId
string
type
string
version
string
senderPublicKey
string
recipientId
string
vendorField
string
timestamp
object
 
timestamp.from
integer
timestamp.to
integer
amount
object
 
amount.from
integer
amount.to
integer
fee
object
 
fee.from
integer
fee.to
integer
 
Suggest Edits

Retrieve a vote

 
gethttps://node1.arknet.cloud/api//votes/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('votes').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "id": "beb8dd43c640f562704090159154b2742afba7eacada9e8edee447e34e7675c6",
        "blockId": "13661015019049808045",
        "type": 3,
        "amount": 0,
        "fee": 100000000,
        "sender": "DAp7JjULVgqzd4jLofkUyLRovHRPUTQwiZ",
        "recipient": "DAp7JjULVgqzd4jLofkUyLRovHRPUTQwiZ",
        "signature": "3045022100e9a743c5aa0df427f49af61d35fe617182479f7e8d368ce23b7ec43ab6d269c80220193aafd4ccb3eedbd76ded7ea99f31629013dc3af60540029fe98b274d42d284",
        "asset": {
            "votes": [
                "+032fe001dff675a6edfe3d0e51201b2900d3b5050a46d770306aefaa574c022672"
            ]
        },
        "confirmations": 48189,
        "timestamp": {
            "epoch": 32338609,
            "unix": 1522439809,
            "human": "2018-03-30T19:56:49Z"
        }
    }
}

Path Params

id
string
required

Unique identifier for the vote.

 
Suggest Edits

List all votes

 
gethttps://node1.arknet.cloud/api//votes
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('votes').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 658,
        "totalCount": 1315,
        "next": "/v2/votes?page=2",
        "previous": null,
        "self": "/v2/votes?page=1",
        "first": "/v2/votes?page=1",
        "last": "/v2/votes?page=658"
    },
    "data": [
        {
            "id": "560959e435cbf8eec60691890f3dd55d141e76077e1fe803f65d137c91099240",
            "blockId": "12872155462883631430",
            "type": 3,
            "amount": 0,
            "fee": 100000000,
            "sender": "DAp7JjULVgqzd4jLofkUyLRovHRPUTQwiZ",
            "recipient": "DAp7JjULVgqzd4jLofkUyLRovHRPUTQwiZ",
            "signature": "30440220522eadff84b5b4b2fc6a3ef611bf093dbd0a06963c32c767ee28729898d0a1d302203f851594e5b2271a987e98daa4fc8b5f384fac65c41eb1c43739af2d4b5dc902",
            "asset": {
                "votes": [
                    "-032fe001dff675a6edfe3d0e51201b2900d3b5050a46d770306aefaa574c022672"
                ]
            },
            "confirmations": 39989,
            "timestamp": {
                "epoch": 32414926,
                "unix": 1522516126,
                "human": "2018-03-31T17:08:46Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
 
Suggest Edits

Retrieve a wallet

 
gethttps://node1.arknet.cloud/api//wallets/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "address": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
        "publicKey": "022cca9529ec97a772156c152a00aad155ee6708243e65c9d211a589cb5d43234d",
        "balance": 12534670000000,
        "isDelegate": true
    }
}

Path Params

id
string
required

Unique identifier for the wallet. (username, address or public key)

 
Suggest Edits

List all wallets

 
gethttps://node1.arknet.cloud/api//wallets
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 421,
        "totalCount": 841,
        "next": "/v2/wallets?page=2",
        "previous": null,
        "self": "/v2/wallets?page=1",
        "first": "/v2/wallets?page=1",
        "last": "/v2/wallets?page=421"
    },
    "data": [
        {
            "address": "D59NTfV92ca9QevUydvMiFMFdubbCaAVCV",
            "publicKey": "037d035f08b3bad0d5bb605232c7aa41555693c480044dbeb797270a44c339da5a",
            "balance": 1023145260990,
            "isDelegate": false
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all top wallets

 
gethttps://node1.arknet.cloud/api//wallets/top
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').top()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": [
        {
            "address": "DGihocTkwDygiFvmg6aG8jThYTic47GzU9",
            "publicKey": "024c8247388a02ecd1de2a3e3fd5b7c61ecc2797fa3776599d558333ef1802d231",
            "balance": 11499593462120632,
            "isDelegate": false
        },
        {
            "address": "DRac35wghMcmUSe5jDMLBDLWkVVjyKZFxK",
            "publicKey": "0374e9a97611540a9ce4812b0980e62d3c5141ea964c2cab051f14a78284570dcd",
            "balance": 554107676293547,
            "isDelegate": false
        },
        ...
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all transactions of a wallet

 
gethttps://node1.arknet.cloud/api//wallets/id/transactions
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').transactions('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 127430,
        "totalCount": 254860,
        "next": "/v2/wallets/boldninja/transactions?page=2",
        "previous": null,
        "self": "/v2/wallets/boldninja/transactions?page=1",
        "first": "/v2/wallets/boldninja/transactions?page=1",
        "last": "/v2/wallets/boldninja/transactions?page=127430"
    },
    "data": [
        {
            "id": "5c6ce775447a5acd22050d72e2615392494953bb1fb6287e9ffb3c33eaeb79aa",
            "blockId": "4271682877946294396",
            "type": 0,
            "amount": 32106400000,
            "fee": 10000000,
            "sender": "DDiTHZ4RETZhGxcyAi1VruCXZKxBFqXMeh",
            "recipient": "DQnQNoJuNCvpjYhxL7fsnGepHBqrumgsyP",
            "signature": "3044022047c39f6f45a46a87f91ca867f9551dbebf0035adcfcbdc1370222c7a1517fc0002206fb5ecc10460e0352a8b626a508e2fcc76e39e490b0a2581dd772ebc8079696e",
            "confirmations": 1683,
            "timestamp": {
                "epoch": 32794053,
                "unix": 1522895253,
                "human": "2018-04-05T02:27:33Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all sent transactions of a wallet

 
gethttps://node1.arknet.cloud/api//wallets/id/transactions/sent
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').sentTransactions('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 2,
        "totalCount": 4,
        "next": "/v2/wallets/boldninja/transactions/sent?page=2",
        "previous": null,
        "self": "/v2/wallets/boldninja/transactions/sent?page=1",
        "first": "/v2/wallets/boldninja/transactions/sent?page=1",
        "last": "/v2/wallets/boldninja/transactions/sent?page=2"
    },
    "data": [
        {
            "id": "08c6b23f9edd97b613f17153fb97a316a4fb83136e9842655dafc8262f363e0e",
            "blockId": "14847399772737279404",
            "type": 3,
            "amount": 0,
            "fee": 100000000,
            "sender": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
            "recipient": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
            "signature": "304402207ba0e8aaee93695360081b7ce713f13d62b544038ac440bd46357398af86cae6022059ac74586738be1ef622e0baba992d0e417d9aed7ab980f374eb0c9d53e25f8e",
            "asset": {
                "votes": [
                    "+0257b7724e97cd832e0c28533a86da5220656f9b5122141daab20e8526decce01f"
                ]
            },
            "confirmations": 1636232,
            "timestamp": {
                "epoch": 17094358,
                "unix": 1507195558,
                "human": "2017-10-05T09:25:58Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all received transactions of a wallet

 
gethttps://node1.arknet.cloud/api//wallets/id/transactions/received
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').receivedTransactions('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 4,
        "totalCount": 8,
        "next": "/v2/wallets/boldninja/transactions/received?page=2",
        "previous": null,
        "self": "/v2/wallets/boldninja/transactions/received?page=1",
        "first": "/v2/wallets/boldninja/transactions/received?page=1",
        "last": "/v2/wallets/boldninja/transactions/received?page=4"
    },
    "data": [
        {
            "id": "c46a6a83f7a358f269691c16f050beeab669767643634086bc12ad1182d54413",
            "blockId": "17271524574301696572",
            "type": 0,
            "amount": 5000000000,
            "fee": 10000000,
            "sender": "DK6Q1Lufhb939H9EshLViYbaaKUkswMiUz",
            "recipient": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
            "signature": "304402204b81411e507273f2a27e6135510abda5bff00a0d3121977df09363227c8fd2360220503cab4484a7db785d91a7adcfad681811e3d73f2d00b4dab7e4190ecd41cb34",
            "vendorField": "More monopoly money for EVERYONE!!",
            "confirmations": 1482069,
            "timestamp": {
                "epoch": 18382414,
                "unix": 1508483614,
                "human": "2017-10-20T07:13:34Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

List all votes of a wallet

 
gethttps://node1.arknet.cloud/api//wallets/id/votes
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').votes('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 2,
        "totalCount": 3,
        "next": "/v2/wallets/boldninja/votes?page=2",
        "previous": null,
        "self": "/v2/wallets/boldninja/votes?page=1",
        "first": "/v2/wallets/boldninja/votes?page=1",
        "last": "/v2/wallets/boldninja/votes?page=2"
    },
    "data": [
        {
            "id": "08c6b23f9edd97b613f17153fb97a316a4fb83136e9842655dafc8262f363e0e",
            "blockId": "14847399772737279404",
            "type": 3,
            "amount": 0,
            "fee": 100000000,
            "sender": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
            "recipient": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
            "signature": "304402207ba0e8aaee93695360081b7ce713f13d62b544038ac440bd46357398af86cae6022059ac74586738be1ef622e0baba992d0e417d9aed7ab980f374eb0c9d53e25f8e",
            "asset": {
                "votes": [
                    "+0257b7724e97cd832e0c28533a86da5220656f9b5122141daab20e8526decce01f"
                ]
            },
            "confirmations": 1636029,
            "timestamp": {
                "epoch": 17094358,
                "unix": 1507195558,
                "human": "2017-10-05T09:25:58Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

 
Suggest Edits

Search all wallets

 
posthttps://node1.arknet.cloud/api//wallets/search
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('wallets').search({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 2,
        "pageCount": 2,
        "totalCount": 3,
        "next": "/v2/wallets/search?page=2",
        "previous": null,
        "self": "/v2/wallets/search?page=1",
        "first": "/v2/wallets/search?page=1",
        "last": "/v2/wallets/search?page=2"
    },
    "data": [
        {
            "id": "08c6b23f9edd97b613f17153fb97a316a4fb83136e9842655dafc8262f363e0e",
            "blockId": "14847399772737279404",
            "type": 3,
            "amount": 0,
            "fee": 100000000,
            "sender": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
            "recipient": "DARiJqhogp2Lu6bxufUFQQMuMyZbxjCydN",
            "signature": "304402207ba0e8aaee93695360081b7ce713f13d62b544038ac440bd46357398af86cae6022059ac74586738be1ef622e0baba992d0e417d9aed7ab980f374eb0c9d53e25f8e",
            "asset": {
                "votes": [
                    "+0257b7724e97cd832e0c28533a86da5220656f9b5122141daab20e8526decce01f"
                ]
            },
            "confirmations": 1636029,
            "timestamp": {
                "epoch": 17094358,
                "unix": 1507195558,
                "human": "2017-10-05T09:25:58Z"
            }
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

Body Params

address
string
publicKey
string
secondPublicKey
string
vote
string
username
string
balance
object
 
balance.from
integer
balance.to
integer
votebalance
object
 
votebalance.from
integer
votebalance.to
integer
 
 
Suggest Edits

Create an account

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.passphrase
string
 
Suggest Edits

Get an account

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.address
string
 
Suggest Edits

Get an accounts transactions

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.address
string
params.offset
integer
 
Suggest Edits

Create a BIP38 account

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.bip38
string
params.userId
string
 
Suggest Edits

Get a BIP38 account

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.userId
string
 
Suggest Edits

Get a block

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.id
string
 
Suggest Edits

Get the latest block

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
 
Suggest Edits

Get a blocks transactions

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.id
string
params.offset
integer
 
Suggest Edits

Transactions

 
Suggest Edits

Broadcast transactions

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.id
string
params.transactions
array of objects
 
Suggest Edits

Create a transaction

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.amount
integer
params.recipientId
string
params.passphrase
string
 
Suggest Edits

Get a transaction

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.id
string
 
Suggest Edits

List transactions

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
 
Suggest Edits

Create a transaction from a BIP38

 
posthttps://json-rpc.arknode.net/
curl --request POST \
  --url https://json-rpc.arknode.net/
var request = require("request");

var options = { method: 'POST', url: 'https://json-rpc.arknode.net/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://json-rpc.arknode.net/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://json-rpc.arknode.net/");

xhr.send(data);
import requests

url = "https://json-rpc.arknode.net/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  result: {
    ...
  }
}
{
  jsonrpc: '2.0',
  id: 'unique-request-id',
  error: {
    code: 'unique-error-code',
    message: 'descriptive-error-message',
    data: 'detailed-error-information'
  }
}

Body Params

jsonrpc
string
id
mixed type
method
string
params
object
 
params.amount
integer
params.recipientId
string
params.bip38
string
params.userId
string
 
Suggest Edits

Create a webhook

 
posthttps://node1.arknet.cloud/api//webhooks
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('webhooks').create({ ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "id": 1,
        "event": "block.forged",
        "target": "https://httpbin.org/post",
        "token": "7e66949f67b36c34a05eeb3a866957b3f1b6f8947fb215500b78e5091d4e484a",
        "enabled": true,
        "conditions": [
            {
                "key": "generatorPublicKey",
                "condition": "eq",
                "value": "032fcfd19f0e095bf46bd3ada87e283720c405249b1be1a70bad1d5f20095a8515"
            }
        ]
    }
}

Body Params

event
string
required
target
string
required
enabled
boolean
conditions
array of objects
key
value
condition

Headers

Authorization
string
required

The webhook token defined in the node configuration.

 
Suggest Edits

Retrieve a webhook

 
gethttps://node1.arknet.cloud/api//webhooks/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('webhooks').get('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "data": {
        "id": 1,
        "event": "block.forged",
        "target": "https://httpbin.org/post",
        "enabled": true,
        "conditions": [
            {
                "key": "generatorPublicKey",
                "condition": "eq",
                "value": "032fcfd19f0e095bf46bd3ada87e283720c405249b1be1a70bad1d5f20095a8515"
            }
        ]
    }
}

Path Params

id
string
required

Unique identifier for the webhook.

Headers

Authorization
string
required

The webhook token defined in the node configuration.

 
Suggest Edits

Update a webhook

 
puthttps://node1.arknet.cloud/api//webhooks/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('webhooks').update('abc123', { ... })

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique identifier for the webhook.

Body Params

event
string
target
string
enabled
boolean
conditions
array of objects
key
value
condition

Headers

Authorization
string
required

The webhook token defined in the node configuration.

 
Suggest Edits

Delete a webhook

 
deletehttps://node1.arknet.cloud/api//webhooks/id
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('webhooks').delete('abc123')

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique identifier for the webhook.

Headers

Authorization
string
required

The webhook token defined in the node configuration.

 
Suggest Edits

List all webhooks

 
gethttps://node1.arknet.cloud/api//webhooks
import Ark from '@arkecosystem/client'

try {
  const client = (new Ark()).getClient()
  client.setVersion(2)
  
  const response = await client.api('webhooks').all()

  console.log(response)
} catch (e) {
  console.log(e.message)
}
A binary file was returned

You couldn't be authenticated

{
    "meta": {
        "count": 29,
        "pageCount": 1,
        "totalCount": 29,
        "next": null,
        "previous": null,
        "self": "/api/v2/webhooks?page=1&limit=100",
        "first": "/api/v2/webhooks?page=1&limit=100",
        "last": "/api/v2/webhooks?page=1&limit=100"
    },
    "data": [
        {
            "id": 1,
            "event": "block.forged",
            "target": "https://httpbin.org/post",
            "enabled": true,
            "conditions": [
                {
                    "key": "generatorPublicKey",
                    "condition": "eq",
                    "value": "032fcfd19f0e095bf46bd3ada87e283720c405249b1be1a70bad1d5f20095a8515"
                }
            ]
        }
    ]
}

Query Params

page
int32

The number of the page that will be returned.

limit
int32

The number of resources per page.

Headers

Authorization
string
required

The webhook token defined in the node configuration.

 
Suggest Edits

JavaScript - Crypto

 

Installation

Usage

Building a new transaction

To build Transaction objects, the @arkecosystem/crypto package includes some utilities. For instance:

const { transactionBuilder } = require('@arkecosystem/crypto')

const transaction = transactionBuilder.transfer()
  .amount(5 * Math.pow(10, 8))
  .senderPublicKey('< sender public key >')
  .recipientId('< recipient address >')
  .sign('< passphrase >')
  .build()

This would provide a full Transaction object.

Broadcasting the transaction to the network is slightly different:

const axios = require('axios')
const { transactionBuilder } = require('@arkecosystem/crypto')

const builder = transactionBuilder.transfer()
  .amount(5 * Math.pow(10, 8))
  .recipientId('< recipient address >')
  .sign('< passphrase >')

const struct = builder.getStruct()

axios
  .post('https://dexplorer.ark.io:8443/peer/transactions', {
    transactions: [struct]
  }, {
    headers: {
      nethash: '578e820911f24e039733b45e4882b73e301f813a0d2c31330dafda84534ffa23',
      version: '1.0.3',
      port: 1
    }
  })
  .then(response => console.log(response.data))

Contributing

Please see https://docs.ark.io/docs/contributing for details.

Suggest Edits

JavaScript - Client

 

Installation

Usage

Contributing

Suggest Edits

PHP - Client

 

Installation

Require this package, with Composer, in the root directory of your project.

$ composer require arkecosystem/client

Usage

<?php

use ArkEcosystem\Client\ConnectionManager;

$manager = new ConnectionManager();

$connection = $manager->connect(new Config([
    'host' => 'http://127.0.0.1'
    'api_version' => 2
]));

dump($connection->api('Transactions')->get('some-transaction-id')->json());

Contributing

Suggest Edits

PHP - Crypto

 

Installation

Require this package, with Composer, in the root directory of your project.

$ composer require arkecosystem/crypto

Usage

<?php

use ArkEcosystem\Crypto\Transactions\Transfer;

$transaction = Transfer::create()
    ->recipient($address)
    ->amount(0.1 * 10 ** 8)
    ->vendorField(str_random(8).' via PHP')
    ->sign($secret)
    ->secondSign($secondSecret);

dump($transaction->getSignedObject());

Contributing

Suggest Edits

Ruby - Client

 

Installation

Add this line to your application's Gemfile:

gem 'ark-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ark-crypto

Usage

Contributing

Suggest Edits

Ruby - Crypto

 

Installation

Add this line to your application's Gemfile:

gem 'ark-crypto'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ark-crypto

Usage

Contributing

Suggest Edits

Elixir - Client

 

Installation

The package can be installed by adding ark_client to your list of dependencies in mix.exs:

def deps do
  [{:ark_client, "~> 0.0.1"}]
end

Usage

Contributing

Suggest Edits

Elixir - Crypto

 

Installation

The package can be installed by adding ark_crypto to your list of dependencies in mix.exs:

def deps do
  [{:ark_crypto, "~> 0.0.1"}]
end

Usage

Contributing