Getting started with the nodela API

Introduction

Nodela has a Restful API with URL endpoints corresponding to actions that users can perform with their channels. The endpoints accept and return JSON encoded objects. The API URL path always contains the API version in order to differentiate queries to different API versions. All queries start with: /api/<version>/ where <version> is an integer representing the current API version.

Mainchain API

using the following api ,we can easyly get a glimps of what is going on in the blockchain.

create a ELA wallet

generate a elastos wallet

GET /api/1/createWallet

Example request:

GET /api/1/createWallet HTTP/1.1
Host: localhost

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result":{
        "privateKey":"492F67D441F563AA4746497EB77C89906A3D3C06B242030BA966BC5604482EF7",
        "publicKey":"035EBC0D70C9E34006C932D7BB47474159C136A8944C92416A94481212379751CB",
        "address":"EJonBz8U1gYnANjSafRF9EAJW9KTwRKd6x"
    },
    "status":200
}
Status Codes:

Check the current network block height

tells you the current block height of the network

GET /api/1/currHeight

Example request:

GET /api/1/currHeight HTTP/1.1
Host: localhost

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "result": 128797,
  "status": 200
}
Status Codes:

get the balance of address

get the balance of the provided public address

GET /api/1/balance/(string:`public_address`)

Example request:

GET /api/1/balance/EbunxcqXie6UExs5SXDbFZxr788iGGvAs9 HTTP/1.1
Host: localhost

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "result":"2.11059400",
    "status":200
}
Status Codes:

Get the transactions of specific height

using height to get block contained transactions

GET /api/1/txs/(int:`block_height`)

get the transactions that the user (block_height) wrote.

Example request:

GET /api/1/txs/10 HTTP/1.1
Host: localhost

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "result": {
      "Transactions": [
          "53b06e08da9362abf50003e26f8b99b38bd32b6a7dfad83203ef5bb9da2f4a05"
      ],
      "Height": 10,
      "Hash": "1166ae059fd6914a44edde9aa8a2765138da0ab868ddaeb51d20d21908c488da"
  },
  "status": 200
}

Signing message using private key

POST /api/1/sign

Example request:

POST /api/1/sign HTTP/1.1
Host: localhost:8090
Content-Type: application/json

  {
      "privateKey":"0D5D7566CA36BC05CFF8E3287C43977DCBB492990EA1822643656D85B3CB0226",
      "msg":"你好，世界"
  }

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "result": {
        "msg": "E4BDA0E5A5BDEFBC8CE4B896E7958C",
        "pub": "02C3F59F337814C6715BBE684EC525B9A3CFCE55D9DEEC53E1EDDB0B352DBB4A54",
        "sig": "E6BB279CBD4727B41F2AA8B18E99B3F99DECBB8737D284FFDD408B356C912EE21AD478BCC0ABD65246938F17DDE64258FD8A9684C0649B23AE1318F7B9CEEEC7"
    },
    "status": 200
}

verify message signed by a public address’s private key

POST /api/1/verify

Example request:

POST /api/1/verify HTTP/1.1
Host: localhost
Content-Type: application/json

  {
      "msg": "E4BDA0E5A5BDEFBC8CE4B896E7958D",
      "pub": "02C3F59F337814C6715BBE684EC525B9A3CFCE55D9DEEC53E1EDDB0B352DBB4A54",
      "sig": "E6BB279CBD4727B41F2AA8B18E99B3F99DECBB8737D284FFDD408B356C912EE21AD478BCC0ABD65246938F17DDE64258FD8A9684C0649B23AE1318F7B9CEEEC7"
  }

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "result": true,
    "status": 200
}

create offline transaction

create a offline transaction utxo json data , you should sign it using private key

POST /api/1/createTx

Example request:

POST /api/1/createTx HTTP/1.1
Host: localhost

  {
      "inputs"  : ["EU3e23CtozdSvrtPzk9A1FeC9iGD896DdV"],
       "outputs" : [{
              "addr":"EPzxJrHefvE7TCWmEGQ4rcFgxGeGBZFSHw",
               "amt" :1000
           }]
  }

Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json

  {
    "result": {
        "Transactions": [
            {
                "UTXOInputs": [
                    {
                        "address": "EU3e23CtozdSvrtPzk9A1FeC9iGD896DdV",
                        "txid": "fa9bcb8b2f3a3a1e627284ad8425faf70fa64146b88a3aceac538af8bfeffd91",
                        "index": 1
                    }
                ],
                "Fee": 100,
                "Outputs": [
                    {
                        "amount": 1000,
                        "address": "EPzxJrHefvE7TCWmEGQ4rcFgxGeGBZFSHw"
                    },
                    {
                        "amount": 99997800,
                        "address": "EU3e23CtozdSvrtPzk9A1FeC9iGD896DdV"
                    }
                ]
            }
        ]
    },
    "status": 200
}

send offline transaction

send raw transaction

POST /api/1/sendRawTx

Example request:

POST /api/1/sendRawTx HTTP/1.1
Host: localhost

  {
     "data":"0200010013313637333832373132343538363832353937350191FDEFBFF88A53ACCE3A8AB84641A60FF7FA2584AD8472621E3A3A2F8BCB9BFA01000000000002B037DB964A231458D2D6FFD5EA18944C4F90E63D547C5D3B9874DF66A4EAD0A3E80300000000000000000000214B177C93439E1E31B1CDA7C3B290F977C74CD0BFB037DB964A231458D2D6FFD5EA18944C4F90E63D547C5D3B9874DF66A4EAD0A368D8F5050000000000000000217779F85469B90D2F648D6BA771FB641D1782715E000000000141407009A5DAB9A8730ED424EF50217180D25AB81F0BB6E8257A672F9618F3CF13FD32D114DE171460C23532319A85614C460E83699C833E576B5C4782232299A2DF232103293CD3A3359B65FEA091CB6260675BD03A3C5E29CFFB504136A508E9BBBD5A8BAC"
  }

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "1f4432635bcf8c347f2bc20b7906c8c6c195f51beb3426e5f8d6a9e4cc073cf3",
    "status": 200
}

transfer ELA using private key

using private key to send transaction

POST /api/1/transfer

Example request:

POST /api/1/transfer HTTP/1.1
Host: localhost

  {
      "sender":[
          {
              "address":"EHLhCEbwViWBPwh1VhpECzYEA7jQHZ4zLv",
              "privateKey":"C740869D015E674362B1F441E3EDBE1CBCF4FE8B709AA1A77E5CCA2C92BAF99D"
          },
          {
              "address":"EbunxcqXie6UExs5SXDbFZxr788iGGvAs9",
              "privateKey":"FABB669B7D2FF2BEBBED1C3F1C9A9519C48993D1FC9D89DCB4C7CA14BDB8C99F"
          }
      ],
      "memo":"测试",
      "receiver":[
          {
              "address":"EbxU18T3M9ufnrkRY7NLt6sKyckDW4VAsA",
              "amount":"2.4"
          }
      ]
  }

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "7bcb5fbf7d6e8f673d50999709d695030dbd6d60a00281221540498cf2830f59",
    "status": 200
}

DID Sidechain API

using the following api , get the did related information

Create DID

create a did with the correspond private key.

GET /api/1/did

Example Request:

GET /api/1/did HTTP/1.1
Host: localhost

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "result": {
      "privateKey": "6E228664BE94833BB18DF6C66BE09173A8F42856E27CCF3DDEADE5785C16FDF7",
      "did": "iXMBmDBXtqTEyiKEVga9dUNqhJBvE74Ln9"
  },
  "status": 200
}

Retrive DID

using private key to retrive did .

GET /api/1/did/(string:`private_key`)

Example Request:

GET /api/1/did/6E228664BE94833BB18DF6C66BE09173A8F42856E27CCF3DDEADE5785C16FDF7 HTTP/1.1
Host: localhost

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "result": "iXMBmDBXtqTEyiKEVga9dUNqhJBvE74Ln9",
  "status": 200
}

Set DID information

setting information into did. using did related privateKey .

POST /api/1/setDidInfo

Example Request:

POST /api/1/setDidInfo HTTP/1.1
Host: localhost

  {
      "privateKey":"FABB669B7D2FF2BEBBED1C3F1C9A9519C48993D1FC9D89DCB4C7CA14BDB8C99F",
      "info":{
          "name":"clark"
      }
  }

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "1170c18870d2547207b85bd9859dc97886ca8f570399da0bcfb40a0bdc2a1b20",
    "status": 200
}

Get DID information

get value from did using transaction hash and key

POST /api/1/getDidInfo

Example Request:

POST /api/1/getDidInfo HTTP/1.1
Host: localhost

  {
      "txIds":[
          "1170C18870D2547207B85BD9859DC97886CA8F570399DA0BCFB40A0BDC2A1B20"
      ],
      "key":"name"
  }

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "clark",
    "status": 200
}

transfer DID asset using private key

using private key to send transaction

POST /api/1/did/transfer

Example request:

POST /api/1/did/transfer HTTP/1.1
Host: localhost

  {
    "sender":[
        {
            "address":"EHLhCEbwViWBPwh1VhpECzYEA7jQHZ4zLv",
            "privateKey":"C740869D015E674362B1F441E3EDBE1CBCF4FE8B709AA1A77E5CCA2C92BAF99D"
        },
        {
            "address":"EbunxcqXie6UExs5SXDbFZxr788iGGvAs9",
            "privateKey":"FABB669B7D2FF2BEBBED1C3F1C9A9519C48993D1FC9D89DCB4C7CA14BDB8C99F"
        }
    ],
    "memo":"测试",
    "receiver":[
        {
            "address":"EbxU18T3M9ufnrkRY7NLt6sKyckDW4VAsA",
            "amount":"2.4"
        }
    ]
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "EB291AA789D542ECE75BCF806A375BD905EDD150046FF52D51DF7D149E37FFF5",
    "status": 200
}

Cross Chain API

using the following api , transfer asset between mainchain and DID Sidechain

Mainchain to Sidechain transfer

using this api you can transfer money from mainchain to did sidechain.

POST /api/1/cross/m2d/transfer

Example Request:

POST /api/1/cross/m2d/transfer HTTP/1.1
Host: localhost

  {
    "sender":[
        {
            "address":"EHLhCEbwViWBPwh1VhpECzYEA7jQHZ4zLv",
            "privateKey":"0D5D7566CA36BC05CFF8E3287C43977DCBB492990EA1822643656D85B3CB0226"
        },
        {
            "address":"EbunxcqXie6UExs5SXDbFZxr788iGGvAs9",
            "privateKey":"FABB669B7D2FF2BEBBED1C3F1C9A9519C48993D1FC9D89DCB4C7CA14BDB8C99F"
        }
    ],
    "receiver":[
        {
            "address":"EbxU18T3M9ufnrkRY7NLt6sKyckDW4VAsA",
            "amount":"0.01"
        }
    ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "B125D3DE38E6F3D17F9DC565996FDB00282BDD46A20F3B25C8EEDA99FC56EABB",
    "status": 200
}

Sidechain to Mainchain transfer

using this api you can transfer money from did sidechain to main chain.

POST /api/1/cross/dm2/transfer

Example Request:

POST /api/1/cross/d2m/transfer HTTP/1.1
Host: localhost

  {
    "sender":[
        {
            "address":"EbxU18T3M9ufnrkRY7NLt6sKyckDW4VAsA",
            "privateKey":"C740869D015E674362B1F441E3EDBE1CBCF4FE8B709AA1A77E5CCA2C92BAF99D"
        }
    ],
    "receiver":[
        {
            "address":"EHLhCEbwViWBPwh1VhpECzYEA7jQHZ4zLv",
            "amount":"0.089698"
        }
    ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "3CDEB61D4CC4541591CDE4B15EB391385715C713D6709FE84381481558C2B69A",
    "status": 200
}