Last updated: 21st of May, 2018

1. Introduction

Launched in 2015, Nano is an open source, sustainable and secure next-generation digital currency focused on removing perceived inefficiencies present in existing cryptocurrencies. Designed to solve peer to peer transfer of value, Nano aims to revolutionize the world economy through an ultrafast and fee-less network that is open and accessible to everyone.

Snapy enables any developer to start easily building on top of Nano in a secure manner. As we grow we will be adding features & libraries to easy in development. Stay tuned :)

2. Register & Generate API Key for your App

Register in a few seconds and generate a new API Key from your Snapy dashboard.

3. Create Nano wallets

Please remember to store the seeds of the wallets you generate. Without this seed, you will not be able to access your funds from any other device. We use your wallet password and email to encrypt your seed, this way we never have access to your seed.

Do not lose it, we cannot access it without your password.

POST snapy.io/api/v1/wallets

Auth header Value
x-api-key pub_5cc7743fd5f7fd24b2e9336e-61defadc-0e7e-4786-a011–0b9d900e263b
JSON Parameter Value
password pass_for_encryption_make_it_long
Example Request
{
"password": "pass_for_encryption_make_it_long"
}
Example Response
{
"seed": "e5a9523842d9dc09b7805d8ec16cd507827e877c1526c702062851892abba05a",
"status": "success"
}

4. Generate Nano addresses

All we need now is to generate an address so we can send some Nano to it and start sending/receiving from it! By the way, due to how Nano works, you can create infinite addresses.

POST snapy.io/api/v1/address

Auth header Value
x-api-key pub_5cc7743fd5f7fd24b2e9336e-61defadc-0e7e-4786-a011–0b9d900e263b
Example Response
{
 "address": "nano_3dckei7mrrgt9t6ae7pw9bjfqbg61h9bfui6pcxgccccjxj3tr9p383w3e3y",
 "remaining": 999,
 "status": "success"
}

5. View balance of addresses

With a quick query you can find out the exact balance of all the Nano addresses you have generated.

GET snapy.io/api/v1/balance

Auth header Value
x-api-key pub_5cc7743fd5f7fd24b2e9336e-61defadc-0e7e-4786-a011–0b9d900e263b
JSON Parameter Value
detailed (optional) true
Example Response
{
    "addresses": {
        "nano_3dckei7mrrgt9t6ae7pw9bjfqbg61h9bfui6pcxgccccjxj3tr9p383w3e3y": "0",
    },
    "balance": "0",
    "status": "success"
}
NOTE: You can get the balance for a specific address by calling
/api/v1/balance/{nano_address}

6. Send a transaction

Send NANO is easy as stating where to and from what address you want the balance to be deducted from.

The value of the amount is in 'nano' units, please check the official documentation on how unit dividers in Nano work before sending anything!

Minimum amount in Snapy is: 1 'nano' = 0.000001 NANO

POST snapy.io/api/v1/send

Auth header Value
x-api-key pub_5cc7743fd5f7fd24b2e9336e-61defadc-0e7e-4786-a011–0b9d900e263b
JSON Parameter Value
to nano_16utdnbztf3411etawb9itaeym814io35mwfzierq5yybn6t5njck87i5az4
from nano_3qxi14ax6aun6fhf5hit7bd4qsbknizrmwnwp6cw7697yyg91p9gnpfqwtg9
amount 1
password The wallet password for this address
Example Response
{
    "hash": "E8339C44117F2C63D3EDC00C64F7277180BCD38BB7DA1B45F0F7B09E9FDD6E95",
    "status": "success"
}

7. Status of Nodes / Block count

Each transaction on the network increases the block count by one, to verify the current status of our nodes you can simply call the following query.

GET snapy.io/api/v1/statusnodes

Auth header Value
x-api-key pub_5cc7743fd5f7fd24b2e9336e-61defadc-0e7e-4786-a011–0b9d900e263b
Example Response
{
    "0": {
        "count": "24615006",
        "unchecked": "405"
    },
    "1": {
        "count": "24615006",
        "unchecked": "369"
    },
    "2": {
        "count": "24615006",
        "unchecked": "394"
    },
    "status": "success"
}

Extra. Webhooks

Subscribe a specific address to a webhook. The webhook URL will receive a restful POST when our Nodes confirm the specified threshold of different nodes that have confirmed the transaction. For extra verification & automation !

POST snapy.io/api/v1/webhooks/address

Auth header Value
x-api-key pub_5cc7743fd5f7fd24b2e9336e-61defadc-0e7e-4786-a011–0b9d900e263b
JSON Parameter Value
address nano_3dckei7mrrgt9t6ae7pw9bjfqbg61h9bfui6pcxgccccjxj3tr9p383w3e3y
url https://yourdomain.com/testhook
confirmations 1 to 6
Example Response of confirmation
{
    "status": "success"
}
Webhook rest POST
{
"hash":"639983283F3EC39290D23312DCAA5A44D04CB699466F9CA1853AF36208FA02C3",
"address":"nano_3dckei7mrrgt9t6ae7pw9bjfqbg61h9bfui6pcxgccccjxj3tr9p383w3e3y",
"amount":"10000",
}