Nano.to API - Web3 Infrastructure for Everyone

Introduction

Nano.to API is organized around REST.

The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Not a developer?

We offer no-code and low-code options to get started.

Public RPC

https://rpc.nano.to

CLIENT LIBRARIES

Axios

$ npm install axios

Authentication

Nano.to uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

API requests must be made over HTTPS. Calls over HTTP will fail.

Public RPC

Bring Nano currency to the people. Free node access for developers, exchanges, and everyone in between.

Base URL

https://rpc.nano.to

CLIENT LIBRARIES

Axios

$ npm install axios

accounts_balances

Returns the balances of multiple accounts specified in the request.

Attributes

accounts array

Array containing Public Nano address or Nano.to @Username

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "accounts_balances",
  "accounts": [
    "@development",
    "nano_3i1aq1cchnmbn9x5rsbap8b15akfh7wj7pwskuzi7ahz8oq6cobd99d4r3b7",
    "@faucet"
  ]
}).then((res) => {
  console.log(res.data);
});

Response

{
  "balances": {
    "@development": {
      "balance": "325586539664609129644855132177",
      "balance_nano": "0.32558653966460912964",
      "pending": "2309372510769300000000000000000000",
      "pending_nano": "2309.3725107693",
      "receivable": "2309372510769300000000000000000000",
      "receivable_nano": "2309.3725107693"
    },
    "nano_3i1aq1cchnmbn9x5rsbap8b15akfh7wj7pwskuzi7ahz8oq6cobd99d4r3b7": {
      "balance": "0",
      "balance_nano": "0",
      "pending": "0",
      "pending_nano": "0",
      "receivable": "0",
      "receivable_nano": "0"
    },
    "@faucet": {
      "balance": "2815988528585400000000000000000",
      "balance_nano": "2.8159885285854",
      "pending": "0",
      "pending_nano": "0",
      "receivable": "0",
      "receivable_nano": "0",
      "address": "nano_1faucet7b6xjyha7m13objpn5ubkquzd6ska8kwopzf1ecbfmn35d1zey3ys"
    }
  }
}

accounts_receivable

Returns the pending receivable blocks for multiple accounts specified in the request.

Attributes

accounts array

Array containing Public Nano address or Nano.to @Username

count number

Limit amount of blocks. Max 1000. Contact us for higher limits.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "accounts_receivable",
  "accounts": [
    "nano_1111111111111111111111111111111111111111111111111117353trpda",
    "nano_3t6k35gi95xu6tergt6p69ck76ogmitsa8mnijtpxm9fkcm736xtoncuohr3"
  ],
  "count": "1"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "blocks": {
    "nano_1111111111111111111111111111111111111111111111111117353trpda": [
      "142A538F36833D1CC78B94E11C766F75818F8B940771335C6C1B8AB880C5BB1D"
    ],
    "nano_3t6k35gi95xu6tergt6p69ck76ogmitsa8mnijtpxm9fkcm736xtoncuohr3": [
      "4C1FEEF0BEA7F50BE35489A1233FE002B212DEA554B55B1B470D78BD8F210C74"
    ]
  }
}

account_balance

Returns the current balance for the specified account.

Attributes

account string

Public Nano address or Nano.to @Username

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "account_balance",
  "account": "@development"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "balance": "325586539664609129644855132177",
  "pending": "2309372510769300000000000000000000",
  "receivable": "2309372510769300000000000000000000",
  "balance_nano": "0.32558653966460912964",
  "pending_nano": "2309.3725107693",
  "receivable_nano": "2309.3725107693"
}

account_history

Returns a list of transactions history for the specified account, including send/receive blocks and amounts.

Attributes

account string

Public Nano address or Nano.to @Username

count number

Limit amount of blocks. Max 1000. Contact us for higher limits.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "account_history",
  "account": "@faucet",
  "count": "1"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "account": "nano_1faucet7b6xjyha7m13objpn5ubkquzd6ska8kwopzf1ecbfmn35d1zey3ys",
  "history": [
    {
      "type": "send",
      "account": "nano_1bank1q3...aosg8kyr51qsdkm8g45",
      "amount": "10000000000000000000000",
      "amount_nano": "0.00000001",
      "local_timestamp": "1679167126",
      "height": "40648",
      "hash": "54DD08EE75157BC03E3B94FBDCBEBF9E3112704F15E21FBD014234FA7ADC131E",
      "confirmed": "true",
      "username": "bank"
    }
  ],
  "previous": "036FF72D6204CAC1024777FE535F4DB5BB4052DF130DC2E431FD360086D71F49"
}

account_info

Returns account information including account balance, block count, and representative for the specified account.

Attributes

account string

Public Nano address or Nano.to @Username

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "account_info",
  "account": "@development"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "frontier": "023B94B7D27B311666C8636954FE17F1FD2EAA97A8BAC27DE5084FBBD5C6B02C",
  "open_block": "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  "representative_block": "023B94B7D27B311666C8636954FE17F1FD2EAA97A8BAC27DE5084FBBD5C6B02C",
  "balance": "325586539664609129644855132177",
  "balance_nano": "0.32558653966460912964",
  "modified_timestamp": "1598514077",
  "block_count": "44",
  "account_version": "2",
  "confirmation_height": "44",
  "confirmation_height_frontier": "023B94B7D27B311666C8636954FE17F1FD2EAA97A8BAC27DE5084FBBD5C6B02C"
}

account_key

Returns the public key for the specified account.

Attributes

account string

Public Nano address or Nano.to @Username

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "account_key",
  "account": "@faucet"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "key": "3068BB1CA04525BB0E4...8B6E8DA958A7FA039"
}

blocks_info

Returns information about multiple blocks specified in the request.

Attributes

source boolean

Return the sending address in response

receive_hash boolean

Return the sending hash in response

hashes array

Array of multiple Nano block hashes

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "blocks_info",
  "source": "true",
  "receive_hash": "true",
  "hashes": [
    "E2FB233EF4554077A7BF1AA85851D5BF0B36965D2B0FB504B2BC778AB89917D3",
    "67D9F9F03566D22926159193BD5BDE549FBE8308807C666BCCD3CEA098FBF49D"
  ]
}).then((res) => {
  console.log(res.data);
});

Response

{
  "blocks": {
    "67D9F9F03566D22926159193BD5BDE549FBE8308807C666BCCD3CEA098FBF49D": {
      "amount": "1240000000000000000000000000",
      "balance": "11017588042701000000000000000000",
      "block_account": "nano_1pnano6m6o1ix3eshr6fj9rryd4ckziyii1mf3ychqno9t3soz638dc9fj9a",
      "confirmed": "true",
      "contents": {
        "account": "nano_1pnano6m6o1ix3eshr6fj9rryd4ckziyii1mf3ychqno9t3soz638dc9fj9a",
        "balance": "11017588042701000000000000000000",
        "link": "3E9955573B6A932AF30DA52C33E8152E78D203ADA8B8BC1DC99E785019A34E9D",
        "link_as_account": "nano_1hnscodmptnm7dsiubbe8hn3cdmrta3tuc7rqigwm9mrc1et8mnxibtso67a",
        "previous": "7FD83954BC187AF1473BAD33F07D4EE634733BFEDBE3D56CC10997F417F3C625",
        "representative": "nano_3pnanopr3d5g7o45zh3nmdkqpaqxhhp3mw14nzr41smjz8xsrfyhtf9xac77",
        "signature": "3D2438195A0E91A1F26C959C47F9014A84C11ED150241B4B017411FA6C79096D74FD7E731D708AFAAEEB7F95534DA7D5D42BB6343D7C3F51CA0BE5520058980F",
        "type": "state",
        "work": "14c98d6e8f7f4ad8",
        "balance_nano": "11.017588042701"
      },
      "height": "271199",
      "local_timestamp": "1674588370",
      "receive_hash": "4DCA5A5E2C732A6899292B9091B7A90CE87E8063954498DF30F469416E6DD6C0",
      "source_account": "0",
      "subtype": "send",
      "successor": "FD83C514FA18E59EF1A3D7C3D3760AEF942C077BD0660A5C4C10F617FFB3D580",
      "balance_nano": "11.017588042701",
      "amount_nano": "0.00124"
    },
    "E2FB233EF4554077A7BF1AA85851D5BF0B36965D2B0FB504B2BC778AB89917D3": {
      "amount": "30000000000000000000000000000000000",
      "balance": "40200000001000000000000000000000000",
      "block_account": "nano_1qato4k7z3spc8gq1zyd8xeqfbzsoxwo36a45ozbrxcatut7up8ohyardu1z",
      "confirmed": "true",
      "contents": {
        "account": "nano_1qato4k7z3spc8gq1zyd8xeqfbzsoxwo36a45ozbrxcatut7up8ohyardu1z",
        "balance": "40200000001000000000000000000000000",
        "link": "87434F8041869A01C8F6F263B87972D7BA443A72E0A97D7A3FD0CCC2358FD6F9",
        "link_as_account": "nano_33t5by1653nt196hfwm5q3wq7oxtaix97r7bhox5zn8eratrzoqsny49ftsd",
        "previous": "6CDDA48608C7843A0AC1122BDD46D9E20E21190986B19EAC23E7F33F2E6A6766",
        "representative": "nano_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh",
        "signature": "A5DB164F6B81648F914E49CAB533900C389FAAD64FBB24F6902F9261312B29F730D07E9BCCD21D918301419B4E05B181637CF8419ED4DCBF8EF2539EB2467F07",
        "type": "state",
        "work": "000bc55b014e807d",
        "balance_nano": "40200.000001"
      },
      "height": "74",
      "local_timestamp": "0",
      "receive_hash": "0000000000000000000000000000000000000000000000000000000000000000",
      "source_account": "nano_1ipx847tk8o46pwxt5qjdbncjqcbwcc1rrmqnkztrfjy5k7z4imsrata9est",
      "subtype": "receive",
      "successor": "678B9357455396B228325CA5A5CA7237DCC42362693DCAEFA840DEE171596349",
      "balance_nano": "40200.000001",
      "amount_nano": "30000"
    }
  }
}

block_count

Returns the number of blocks in the ledger.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "block_count"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "block_count": "175659188",
  "cemented_count": "175659165",
  "unchecked_count": "23"
}

block_info

Returns information about a specific block identified by its block hash.

Attributes

hash string

Nano block hash

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "block_info",
  "hash": "B5E0BE6DAB75740A...06CC4EC7A548F4AFD37A"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "block_account": "nano_36zroxcwrc3okientagy18ccr51fz9qbj3y9guwzroh46uu3oyford19n5sp",
  "amount": "110000000000000000000000000000",
  "amount_nano": "0.11",
  "balance": "1798087000000000000000000000000",
  "balance_nano": "1.798087",
  "height": "347",
  "local_timestamp": "1679170643",
  "successor": "0000000000000000000000000000000000000000000000000000000000000000",
  "confirmed": "true",
  "contents": {
    "type": "state",
    "account": "nano_36zroxcwrc3okientagy18ccr51fz9qbj3y9guwzroh46uu3oyford19n5sp",
    "previous": "F87183445CCBDA814D4FEA653D58DAA5E0BE35ACE33FF04ED1EC7B79430A1DF9",
    "representative": "nano_3pnanopr3d5g7o45zh3nmdkqpaqxhhp3mw14nzr41smjz8xsrfyhtf9xac77",
    "balance": "1798087000000000000000000000000",
    "balance_nano": "1.798087",
    "link": "3A9938F2E17DE4DA81D4E4FA413B1291BBCAC7839775BC76562731386B547883",
    "link_as_account": "nano_1gns95sg4zh6uc1xbs9ta6xj76fusd5r97uoqju7ebsj93ooay656kwa6i8p",
    "signature": "04320501F47B4FD291B5EC7438F31BEAF59B22A447E33021296F3113C38FC26375C4DB14C26901159A900DAB18E91CA5152C6FE8DB5F19B70A3E4FE54048FD09",
    "work": "1ed0bc478d446610"
  },
  "subtype": "send"
}

checkout

Create non-custodial payments sessions for the Nano blockchain.

Attributes

title string

The Nano address which the user will pay and funds will be send to.

notify string

Valid email address(s) to receive payment notification.

webhook string

Private HTTP(S) URL to receive payment notification via POST body.

address string

The Nano address which the user will pay and funds will be send to.

line_items array

Array of products including: title, price and quantity.

success_url array

Used for Nano.to Checkout UI, users are redirect to this url after payment.

amount number

The Nano amount for Checkout session.

shipping number

Add a shipping cost to the checkout.

metadata object

Set of key-value pairs that you can attach to an object. Useful for attaching custom information to the Checkout session.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "checkout",
  "title": "T-Shirt Store",
  "webhook": "https://example/webhook/secret",
  "address": "YOUR_ADDRESS",
  "line_items": [
    {
      "title": "Nike T-Shirt",
      "price": 40,
      "quantity": 1,
      "variant": 28474
    }
  ],
  "metadata": {
    "secret": "joe-doe"
  }
}).then((res) => {
  console.log(res.data);
});

Response

{
  "id": "CHECKOUT_ID",
  "browser": "https://nano.to/CHECKOUT_ID",
  "json": "https://api.nano.to/checkout/CHECKOUT_ID",
  "check": "https://api.nano.to/confirm/CHECKOUT_ID",
  "address": "YOUR_ADDRESS",
  "amount": "0.133",
  "amount_raw": "133000000000000000000000000000",
  "link": "nano:YOUR_ADDRESS?amount=133000047580000000000000000000",
  "qrcode": "data:image/png;base64.."
}

Webhook POST (Private)

{
  "block": {
    "hash": "786DD3F82BFEAF80A668EB87498531DE114F1A9BB7AF30558B4136AB69F5133E",
    "account": "PAYER_ADDRESS",
    "amount": 50,
    "amount_raw": "500000000000000000000000000000"
  },
  "line_items": [
    {
      "title": "Nike T-Shirt",
      "price": 40,
      "quantity": 1,
      "variant": 28474
    }
  ],
  "email": "[email protected]",
  "shipping": {
    "city": "Miami",
    "country": "US",
    "street_address": "123 Fake Ave",
    "street_address_two": "Apt. 4",
    "postal_code": "90210",
    "state": "FL"
  },
  "shipping_amount": 10,
  "metadata": {
    "secret": "joe-doe"
  },
  "success_url": "https://example.com/success/{CHECKOUT_SESSION_ID}",
  "webhook": {
    "response": "FROM_YOUR_SERVER"
  },
  "checkout": "https://api.nano.to/checkout/CHECKOUT_ID"
}

find_block

Finds and returns the block hash for a specific transaction identifier.

Attributes

account string

Public Nano address or Nano.to @Username

amount boolean

Payment amount of block

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "find_block",
  "account": "@bank",
  "amount": "0.00755"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "block": {
    "type": "receive",
    "account": "nano_1rpc19tpfzuotsk346bt674mehj96ju86n5xiop4o68mepqexf5f55xa7ycx",
    "amount": "0.00755",
    "local_timestamp": "1712536738",
    "height": "5873",
    "hash": "B64C23DD46A05B9774F4812E86463815784CFA37E834ED5F2F77B13A9C6D6254",
    "confirmed": "true",
    "amount_nano": "0.00755",
    "username": "Rpc",
    "amount_raw": "7550000000000000000000000000"
  }
}

get_name

Register Nano.to Username via API. Paid with Nano.

Attributes

name string

Valid username to register.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "get_name",
  "name": "NanoBull"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "id": "CHECKOUT_ID",
  "address": "nano_1name....",
  "browser": "http://nano.to/pay_CHECKOUT_ID",
  "check": "https://rpc.nano.to/check/CHECKOUT_ID",
  "available": true,
  "plans": [
    {
      "value": "0.0106987",
      "title": "2 Days",
      "value_raw": "10698700000000000000000000000"
    },
    {
      "value": "0.0508923",
      "title": "1 Month",
      "discount": 50,
      "value_raw": "50892300000000000000000000000"
    },
    {
      "value": "0.309268",
      "title": "1 Year",
      "discount": 50,
      "value_raw": "309268000000000000000000000000"
    },
    {
      "value": "0.505576",
      "title": "2 Years",
      "discount": 50,
      "value_raw": "505576000000000000000000000000"
    },
    {
      "value": "10.04408",
      "title": "10 Years",
      "value_raw": "10044080000000000000000000000000"
    }
  ]
}

market_data

Returns market data information related to Nano cryptocurrency.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "market_data"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "source": "coingecko.com",
  "id": "nano",
  "symbol": "xno",
  "name": "Nano",
  "hashing_algorithm": "Directed Acyclic Graph (DAG)",
  "categories": [
    "Cryptocurrency"
  ],
  "public_notice": "Nano has rebranded to a new ticker $XNO. Read more at: https://medium.com/@nanocurrency/say-hello-to-xno-7ed55e419e3f",
  "links": {
    "homepage": [
      "https://nano.org/en"
    ],
    "blockchain_site": [
      "https://nanolooker.com/"
    ],
    "official_forum_url": [
      "https://medium.com/nanocurrency"
    ],
    "chat_url": [
      "https://discordapp.com/invite/Jph***",
      "https://chat.nano.org/"
    ],
    "announcement_url": [
      "https://nanoticker.info/",
      "https://nault.cc/"
    ],
    "twitter_screen_name": "nano",
    "facebook_username": "nanofoundation",
    "bitcointalk_thread_identifier": null,
    "telegram_channel_identifier": "nanocurrency",
    "subreddit_url": "https://www.reddit.com/r/nanocurrency",
    "repos_url": {
      "github": [
        "https://github.com/nanocurrency/raiblocks"
      ],
      "bitbucket": []
    }
  },
  "image": {
    "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
    "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
    "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
  },
  "sentiment_votes_up_percentage": 60,
  "sentiment_votes_down_percentage": 40,
  "watchlist_portfolio_users": 48007,
  "market_cap_rank": 263,
  "coingecko_rank": 33,
  "coingecko_score": 53.169,
  "developer_score": 86.2,
  "community_score": 45.614,
  "liquidity_score": 38.51,
  "public_interest_score": 0.004,
  "market_data": {
    "current_price": {
      "btc": 0.00002341,
      "usd": 0.704173
    },
    "total_value_locked": null,
    "mcap_to_tvl_ratio": null,
    "fdv_to_tvl_ratio": null,
    "roi": null,
    "ath": {},
    "ath_change_percentage": {},
    "ath_date": {},
    "atl": {},
    "atl_change_percentage": {},
    "atl_date": {},
    "market_cap": {},
    "market_cap_rank": 263,
    "fully_diluted_valuation": {},
    "total_volume": {},
    "high_24h": {},
    "low_24h": {},
    "price_change_24h": -0.004395865597632,
    "price_change_percentage_24h": -0.62039,
    "price_change_percentage_7d": 3.88828,
    "price_change_percentage_14d": 3.28418,
    "price_change_percentage_30d": -11.80108,
    "price_change_percentage_60d": -9.46265,
    "price_change_percentage_200d": 1.74205,
    "price_change_percentage_1y": -17.43601,
    "market_cap_change_24h": -529418.1285252,
    "market_cap_change_percentage_24h": -0.56125,
    "price_change_24h_in_currency": {},
    "price_change_percentage_1h_in_currency": {},
    "price_change_percentage_24h_in_currency": {},
    "price_change_percentage_7d_in_currency": {},
    "price_change_percentage_14d_in_currency": {},
    "price_change_percentage_30d_in_currency": {},
    "price_change_percentage_60d_in_currency": {},
    "price_change_percentage_200d_in_currency": {},
    "price_change_percentage_1y_in_currency": {},
    "market_cap_change_24h_in_currency": {},
    "market_cap_change_percentage_24h_in_currency": {},
    "total_supply": 133248290,
    "max_supply": 133248290,
    "circulating_supply": 133248290,
    "last_updated": "2023-07-06T14:41:51.470Z"
  },
  "public_interest_stats": {
    "alexa_rank": 313412,
    "bing_matches": null
  },
  "status_updates": [
    {
      "description": "In the lead up to Follis V23, get up to speed with the software improvements that will allow for faster and more stable development.\r\n\r\nFeatures include:\r\n🔹 Node initialisation parameter redesign\r\n🔹 Ledger constraints\r\n🔹 New naming conventions\r\n🔹 Updated integration docs\r\n\r\nhttps://blog.nano.org/v23-0-follis-development-update-55ef8c41cbb",
      "category": "general",
      "created_at": "2021-10-04T20:45:57.611Z",
      "user": "Naome Jones",
      "user_title": "Communications Manager",
      "pin": false,
      "project": {
        "type": "Coin",
        "id": "nano",
        "name": "Nano",
        "symbol": "xno",
        "image": {
          "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
          "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
          "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
        }
      }
    },
    {
      "description": "The latest Nano Digest has hit the timeline.\r\nJoin us for a round-up of everything new in the NANO ecosystem.\r\n\r\nhttps://blog.nano.org/nano-digest-cyberfirst-cryptouk-coincloud-dcm-nowpayments-pos-nano-community-program-and-a86bacb45133 ",
      "category": "general",
      "created_at": "2021-10-02T18:26:04.434Z",
      "user": "Naome Jones",
      "user_title": "Communications Manager",
      "pin": false,
      "project": {
        "type": "Coin",
        "id": "nano",
        "name": "Nano",
        "symbol": "xno",
        "image": {
          "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
          "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
          "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
        }
      }
    },
    {
      "description": "It is with great pride that we announce our support for Cyber First, an educational programme created by the National Cyber Security Centre to develop the UK's next generation of cyber professionals by helping young people aged 11-17 in the UK explore their passion for tech.\r\n\r\nFind out more about Cyber First here: https://www.ncsc.gov.uk/cyberfirst/overview\r\n",
      "category": "general",
      "created_at": "2021-10-01T10:27:55.398Z",
      "user": "Naome Jones",
      "user_title": "Communications Manager",
      "pin": false,
      "project": {
        "type": "Coin",
        "id": "nano",
        "name": "Nano",
        "symbol": "xno",
        "image": {
          "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
          "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
          "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
        }
      }
    },
    {
      "description": "1 HOUR TO GO until the Fintech & FS Group: Communicating crypto in 2021 event!\r\n\r\nCheck out the impressive lineup of speakers including George Coxon of Nano Foundation, Roopa Ramaiya of Luno, Elliott Suthers of Coinbase, Christian Williams of Crypto Briefing, Samantha Yap of YAP Global Ltd.\r\n\r\nHosted by the PRCA.\r\n\r\nREGISTER HERE: https://www.prca.org.uk/event/4944/communicating-crypto-in-2021%3A-how-to-talk-crypto-without-alienating-traditional-financial-audiences",
      "category": "general",
      "created_at": "2021-09-09T13:39:22.682Z",
      "user": "Naome Jones",
      "user_title": "Communications Manager",
      "pin": false,
      "project": {
        "type": "Coin",
        "id": "nano",
        "name": "Nano",
        "symbol": "xno",
        "image": {
          "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
          "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
          "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
        }
      }
    },
    {
      "description": "You can now buy and sell NANO with INR & USDT on Indian exchange Koinbazar\r\n\r\nhttps://www.koinbazar.com/blog/buy-sell-trade-nano-on-koinbazar",
      "category": "general",
      "created_at": "2021-08-16T15:50:16.901Z",
      "user": "Naome Jones",
      "user_title": "Communications Manager",
      "pin": false,
      "project": {
        "type": "Coin",
        "id": "nano",
        "name": "Nano",
        "symbol": "xno",
        "image": {
          "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
          "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
          "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
        }
      }
    },
    {
      "description": "That's right, your Friday just got a whole lot better! \r\nThe latest Nano Digest just dropped. Join us as we catch up on everything new in the Nano ecosystem.\r\n\r\nhttps://medium.com/nanocurrency/nano-digest-nano-on-airtm-p2p-new-partnerships-team-updates-media-moments-charitable-252b42ea44a7\r\n",
      "category": "general",
      "created_at": "2021-07-16T16:26:50.772Z",
      "user": "Naome Jones",
      "user_title": "Communications Manager",
      "pin": false,
      "project": {
        "type": "Coin",
        "id": "nano",
        "name": "Nano",
        "symbol": "xno",
        "image": {
          "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
          "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
          "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
        }
      }
    },
    {
      "description": "Great news Argentina & Venezuela! NANO is now available on the Airtm P2P Marketplace!\r\n\r\nhttps://medium.com/nanocurrency/nano-is-now-available-on-airtm-p2p-marketplace-28ad9acfc856",
      "category": "general",
      "created_at": "2021-07-08T16:41:33.669Z",
      "user": "Naome Jones",
      "user_title": "Communications Manager",
      "pin": false,
      "project": {
        "type": "Coin",
        "id": "nano",
        "name": "Nano",
        "symbol": "xno",
        "image": {
          "thumb": "https://assets.coingecko.com/coins/images/756/thumb/nano.png?1637232468",
          "small": "https://assets.coingecko.com/coins/images/756/small/nano.png?1637232468",
          "large": "https://assets.coingecko.com/coins/images/756/large/nano.png?1637232468"
        }
      }
    }
  ],
  "last_updated": "2023-07-06T14:41:51.470Z"
}

nano_to_raw

Converts Nano currency amount (in Nano) to its raw value.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "nano_to_raw"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "raw_value": "1000000000000000000000000"
}

price

Returns the current price information for Nano cryptocurrency.

Attributes

currency string

Valid ISO currency symbol.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "price",
  "currency": "EUR"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "symbol": "xno",
  "currency": "eur",
  "price": 1.019,
  "timestamp": "January 17, 2024 1:36 PM",
  "timestamp_unix": 1705516615,
  "source": "coingecko.com"
}

process

Processes a block and performs validation and state transition for the account.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "process",
  "json_block": "true",
  "subtype": "send",
  "block": {
    "type": "state",
    "account": "nano_1qato4k7z3spc8gq1zyd8xeqfbzsoxwo36a45ozbrxcatut7up8ohyardu1z",
    "previous": "6CDDA48608C7843A...EAC23E7F33F2E6A6766",
    "representative": "nano_3pczxuorp48td8645bs3m6c3xotxd3idskrenmi65rbrga5zmkemzhwkaznh",
    "balance": "40200000001000000000000000000000000",
    "link": "87434F8041869A0...7D7A3FD0CCC2358FD6F9",
    "link_as_account": "nano_33t5by1653nt196hfwm5q3wq7oxtaix97r7bhox5zn8eratrzoqsny49ftsd",
    "signature": "A5DB164F6B81648533900C3...ED4DCBF8EF2539EB2467F07",
    "work": "000bc55b014e807d"
  }
}).then((res) => {
  console.log(res.data);
});

Response

{
  "hash": "7D27B311666C8...6C8637D277F1FD2ED"
}

raw_to_nano

Converts raw value to Nano currency amount (in Nano).

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "raw_to_nano"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "nano_value": "1"
}

receivable

Returns the list of pending receivable blocks for the account, which are ready to be received.

Attributes

account string

Public Nano address or Nano.to @Username

count number

Limit amount of blocks. Max 1000. Contact us for higher limits.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "receivable",
  "account": "@faucet",
  "count": "5"
}).then((res) => {
  console.log(res.data);
});

Response

[
  {
    "hash": "9DA74CCE700808EB4BB91DB43F42E739244B0FD5F2BB0D00B2C7F9074C367E83",
    "source": "nano_38gxz93y39yqbeqkcgcyrhkyu183otfpaymjcstzsa9isp9epdsudhmf9shm",
    "amount": "100000000000000000000000000000",
    "amount_nano": "0.1"
  },
  {
    "hash": "A12FC2862F07F1CEFF8C848C8AD5B13E41578959C526588B5940CAA27B7B215E",
    "source": "nano_16ouai59d7eu4mnd9rxojncey65p1d5r3oipxyn1ceqgjkxtx8n5hxremooi",
    "amount": "1000000000000000000000000000",
    "amount_nano": "0.001"
  },
  {
    "hash": "C11BC728B8007CC875AA75040E8563C2C9195BAEE0A3CA424E98D089F7A336F5",
    "source": "nano_3qx5cz95xxpd5wsm9imggxpuxhpf5oupx14456ms5f5hn9qhyexiszfhshfb",
    "amount": "1000971397140000000000000000",
    "amount_nano": "0.00100097139714",
    "username": "lorem"
  }
]

reps

Returns a list of representatives (delegates) for voting on the Nano network.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "reps"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "representatives": [
    "nano_rep1...",
    "nano_rep2..."
  ]
}

rep_info

Returns detailed information about a specific representative (delegate).

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "rep_info"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "info": {
    "account": "nano_rep1...",
    "online": true,
    "uptime": "98%",
    "voting_power": "5%"
  }
}

update_name

Updating names is free, because you pay your own address.

Attributes

name string

Your username to update.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "update_name",
  "name": "NanoBull"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "address": "nano_37y6iq8m1zx...9jrcwhkmoxpo61f4o",
  "browser": "http://nano.to/pay_f2b27af7",
  "check": "https://api.nano.to/check/f2b27af7",
  "update_name": "@NanoBull",
  "amount": "0.00884"
}

version

Returns version information for RPC, Store, Protocol (network), Node (Major & Minor version).

Since version 20.0 also returns the Network label and identifier (hash of the genesis open block), and Build Info.

Since version 21.0 also returns Database backend information.

RPC Version always returns "1" as of 01/11/2018

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "version"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "rpc_version": "1",
  "store_version": "22",
  "protocol_version": "19",
  "node_vendor": "Nano V25.0",
  "store_vendor": "LMDB 0.9.25",
  "network": "live"
}

work_generate

Generates proof of work for a given block hash and difficulty threshold.

RPC API Key Required: Get Free API Key

Attributes

hash string

Nano block hash. If first block, use account_key.

api_key string required

Nano.to API Key. Can be passed via Authorization header as well.

Axios

const axios = require('axios');

axios.post('https://rpc.nano.to', {
  "action": "work_generate",
  "hash": ":FRONTIER",
  "api_key": "YOUR_RPC_KEY"
}).then((res) => {
  console.log(res.data);
});

Response

{
  "difficulty": "fffffff800000000",
  "multiplier": "1.4403398628545552",
  "work": "4e278d4edc807508",
  "frontier": "7D27B311666C82....6C8637D277F1FD2ED",
  "duration": "0.883s",
  "credits": 9,
  "cached": false
}

Cloud Checkouts

Checkout represent one-time purchases. They make it easy to build with Nano.

You can create Checkouts on your server and in the browser.

Cloud API Key Required: Get Free API Key

Base URL

https://cloud.nano.to

Endpoints

GET /v1/checkouts/:id/confirm

POST /v1/checkouts

GET /v1/checkouts

GET /v1/checkouts/:id

CLIENT LIBRARIES

NodeJS

$ npm install @nano/cloud

Confirm Checkout

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const payment = await nano.checkouts.confirm('ID')

Response

{
  "id": "35c89c84",
  "success": true,
  "block": "8CE82716B4B431A229...50174F2444E7B24EFD",
  "amount": "0.0133001831",
  "amount_raw": "13300183100000000000000000000",
  "address": "PAYER_ADDRESS",
  "nanolooker": "https://nanolooker.com/block/8CE82716B4B431A229...50174F2444E7B24EFD",
  "json": "https://api.nano.to/checkout/35c89c84"
}

Create Checkout

Attributes

title string

The Nano address which the user will pay and funds will be send to.

notify string

Valid email address(s) to receive payment notification.

webhook string

Private HTTP(S) URL to receive payment notification via POST body.

address string

The Nano address which the user will pay and funds will be send to.

amount number

The Nano amount for Checkout session.

metadata object

Set of key-value pairs that you can attach to an object. Useful for attaching custom information to the Checkout session.

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const checkout = await nano.checkouts.create({
  "title": "Nano Bird Feeder",
  "notify": "[email protected]",
  "webhook": "https://example/webhook/secret",
  "address": "YOUR_ADDRESS",
  "amount": "0.133",
  "metadata": {
    "secret": "joe-doe"
  }
})

Response

{
  "id": "CHECKOUT_ID",
  "browser": "https://nano.to/CHECKOUT_ID",
  "json": "https://api.nano.to/checkout/CHECKOUT_ID",
  "check": "https://api.nano.to/confirm/CHECKOUT_ID",
  "address": "YOUR_ADDRESS",
  "amount": "0.133",
  "amount_raw": "133000000000000000000000000000",
  "link": "nano:YOUR_ADDRESS?amount=133000047580000000000000000000",
  "qrcode": "data:image/png;base64.."
}

List Checkouts

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const checkouts = await nano.checkouts.list()

Response

[
  {
    "id": "CHECKOUT_ID",
    "browser": "https://nano.to/CHECKOUT_ID",
    "json": "https://api.nano.to/checkout/CHECKOUT_ID",
    "check": "https://api.nano.to/confirm/CHECKOUT_ID",
    "address": "YOUR_ADDRESS",
    "amount": "0.133",
    "amount_raw": "133000000000000000000000000000",
    "link": "nano:YOUR_ADDRESS?amount=133000047580000000000000000000",
    "qrcode": "data:image/png;base64.."
  }
]

Retrieve Checkout

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const checkout = await nano.checkouts.get('ID')

Response

{
  "id": "CHECKOUT_ID",
  "browser": "https://nano.to/CHECKOUT_ID",
  "json": "https://api.nano.to/checkout/CHECKOUT_ID",
  "check": "https://api.nano.to/confirm/CHECKOUT_ID",
  "address": "YOUR_ADDRESS",
  "amount": "0.133",
  "amount_raw": "133000000000000000000000000000",
  "link": "nano:YOUR_ADDRESS?amount=133000047580000000000000000000",
  "qrcode": "data:image/png;base64.."
}

Cloud Wallets

Encrypted programmatic wallets for the Nano blockchain.

Cloud API Key Required: Get Free API Key

Base URL

https://cloud.nano.to

Endpoints

POST /v1/wallets/change_rep

POST /v1/wallets

GET /v1/wallets

POST /v1/wallets/receive

GET /v1/wallets/:address

POST /v1/wallets/send

POST /v1/wallets/:address

CLIENT LIBRARIES

NodeJS

$ npm install @nano/cloud

Change Nano Wallet Rep

Attributes

account string

Nano wallet to change Rep.

representative string

New representative nano address

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const change_rep = await nano.wallets.change_rep('ID', {
  "account": "nano_3rzpo..tj5ni",
  "representative": "nano_fosse..tj5ni"
})

Create Nano Wallet

Attributes

note string

Attach custom note to wallet.

scope string / array

Control access to wallet.

metadata object

Set of key-value pairs

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const wallet = await nano.wallets.create({
  "note": "Created via API",
  "scope": "Example App",
  "metadata": {
    "userId": "john-doe"
  }
})

Response

{
  "accountIndex": 13,
  "address": "nano_1s88wp4z5sfc9y4kza61rn3...j4ozhhyasuhrpbonob5",
  "created": 1720924067029,
  "scope": [
    "Example App"
  ],
  "note": "Created via API"
}

List Nano Wallets

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const wallets = await nano.wallets.list()

Response

[
  {
    "accountIndex": 13,
    "address": "nano_1s88wp4z5sfc9y4kza6..odj4ozhhyasuhrpbonob5",
    "created": 1720924067029,
    "scope": [
      "Example App"
    ],
    "note": "Created via API",
    "fromNow": "just now",
    "balance": "0",
    "pending": "0",
    "receivable": "0",
    "balance_nano": "0",
    "receivable_nano": "0"
  },
  {
    "accountIndex": 12,
    "address": "nano_3rzpoksdk361a3j4pyp..pdiaduhnqjq4fbtristj5ni",
    "note": "Test",
    "created": 1720923686941,
    "scope": [
      "Web App"
    ],
    "fromNow": "6 minutes ago",
    "balance": "0",
    "pending": "0",
    "receivable": "0",
    "balance_nano": "0",
    "receivable_nano": "0"
  }
]

Receive Nano to Address

Attributes

accounts array

Array of Nano wallet address to receive.

blocks string

Optional. Array of block hash to receive.

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const receive = await nano.wallets.receive('ID', {
  "account": "nano_3rzpo..tj5ni"
})

Retrieve Nano Wallet

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const wallet = await nano.wallets.get('ID')

Response

{
  "accountIndex": 12,
  "address": "nano_3rzpoksdk361a3j4pyp..pdiaduhnqjq4fbtristj5ni",
  "note": "Test",
  "created": 1720923686941,
  "scope": [
    "Web App"
  ],
  "fromNow": "6 minutes ago",
  "balance": "0",
  "pending": "0",
  "receivable": "0",
  "balance_nano": "0",
  "receivable_nano": "0"
}

Send Nano to Address

Send funds to any valid Nano address.

Attributes

to string

Public Nano wallet of recipient.

from string

Public Nano wallet address to send from.

amount number

Nano amount to send.

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const send = await nano.wallets.send('ID', {
  "to": "@development",
  "from": "nano_3rzpoksdk3...4fbtristj5ni",
  "amount": "0.133",
  "note": "Tip"
})

Update Nano Wallet

Attributes

note string

Attach custom note to wallet.

scope string / array

Control access to wallet.

metadata object

Set of key-value pairs

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const wallet = await nano.wallets.update('ID', {
  "note": "Mom's Account"
})

Nano Products

Products describe specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version; each version would be a separate Product.

Cloud API Key Required: Get Free API Key

Base URL

https://cloud.nano.to

Endpoints

POST /v1/products

DELETE /v1/products/:id

GET /v1/products

GET /v1/products/:id

POST /v1/products/:id

CLIENT LIBRARIES

NodeJS

$ npm install @nano/cloud

Create Product

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const product = await nano.products.create({
  "title": "My First Product",
  "price": "10.00",
  "currency": "Ӿ"
})

Delete Product

NodeJS

const nano = require('@nano/cloud')('API_KEY')

List Products

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const products = await nano.products.list()

Response

[
  {
    "title": "Test Product",
    "id": "ae07a195b04b8",
    "category": "Test",
    "price": "5",
    "currency": "Ӿ",
    "inventory": "5",
    "images": [
      "https://img.nano.to/1719337840466.jpg"
    ],
    "cost_per_item": "1"
  }
]

Retrieve Product

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const products = await nano.products.get('ID')

The Product object

Attributes

title string

Product title.

description string

Product description.

category string

Product category. Example: T-Shirt, Sticker

images array

Array of product image URLs.

currency string

ISO string of product currency For nano use 'XNO' or 'NANO'.

inventory number

Optional. Stock number of product.

cost_per_item number

Optional. Internal information for calculating profit.

price number

The price for this product.

Product object

{
  "title": "My First Product",
  "price": "10.00",
  "currency": "NANO"
}

Update Product

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const product = await nano.products.get('ID')

Nano Orders

Orders represent one-time purchases.

Cloud API Key Required: Get Free API Key

Base URL

https://cloud.nano.to

Endpoints

POST /v1/orders

GET /v1/orders

GET /v1/orders/:id

POST /v1/orders/:id

CLIENT LIBRARIES

NodeJS

$ npm install @nano/cloud

Create Order

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const order = await nano.orders.create({
  "status": "draft",
  "line_items": [
    {
      "product": "PRODUCT_ID",
      "quantity": 2
    }
  ]
})

List Orders

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const orders = await nano.orders.list()

Retrieve Order

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const order = await nano.orders.get('ID')

Update Order

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const order = await nano.orders.update('ID', {
  "status": "complete"
})

Nano Customers

Customers are users who complete checkouts. They can also be created and managed proactively.

Cloud API Key Required: Get Free API Key

Base URL

https://cloud.nano.to

Endpoints

POST /v1/customers

GET /v1/customers

GET /v1/customers/:id

POST /v1/customers/:id

CLIENT LIBRARIES

NodeJS

$ npm install @nano/cloud

Create Customer

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const customer = await nano.customers.create({
  "name": "John Doe"
})

List Customers

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const customers = await nano.customers.list()

Retrieve Customer

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const customer = await nano.customers.get('ID')

Update Customer

NodeJS

const nano = require('@nano/cloud')('API_KEY')

const order = await nano.customers.update('ID', {
  "age": "45"
})