Introduction

The Gudix® Ledger is accessible via an API interface. The interface guarantees a connection to any application. The creation of a nullet and the use of Gudix® Net is free and unlimited. Gudix is responsible for ensuring that Nuts and tokens can change owners securely via the interface.

Extensions

This API documentation and the API interface are constantly being expanded. Please let us know what information you need so that we can activate the extension. all information on gudix net is also accessible via the API.

JSON Format

Read the interface documentation for more details. The API interface only accepts JSON-formatted requests and also delivers responses in JSON-formatted form. The interface accepts JSON body information.

HTTP/HTTPS

We communicate via HTTPS. For security reasons, we recommend using HTTPS only. HTTP requests will be redirected to HTTPS.

Errors

We strive to ensure the use of the interface as uniformly as possible. If a format is incorrect or something else goes wrong, we will return a status code 400 with a JSON error and a short explanation.

Requestmethods

Only POST or GET Methods allowed.

How to connect to the interface

Every program and every application that allow HTTPS requests are suitable to access the Gudix® Net. A relatively simple use can be realized with Postman. Simply import the collection into POSTMAN, complete parameters and get started.

Enduser Interface

As an enduser it's recommended to use web interface to access to the Gudix® Net. Just press the login button.

Test the Gudix Network trough Postman Interface

Create nullet


To generate a nullet, all you need is an individual password. We encrypt the password and supplement it with server information, which results in a nullet id. The nullet id is for private use only and not for public. Only creator can see the nullet id, not even we know your nullet id. Only those who have the nullet id and password can access the content. We recommend that you print out the nullet id for restore purpuse. We also see an advantage in having the nullet id generated as a QR code.


https://api.gudix.net/createnullet
POST

password string

Random String and free of choice in characters and length. Please choose high security password in your own choice. The password can't be changed. Choose wise


webhook string

we send POST Request to this URL when recieving nuts.

JSON Body:
{
	"password": "whatYouWant"
}
Response:
{
    "nullet": "C8BNwokULVf2YmvUJtI2_RI3iEdLKRdG3YpVEMnXlSrFFAz0x0uz62bs4vTsSy0X22GB3lJdLltA9Ptd8lwv7G_Cy12M5QA4xGjROaRaY1VzGUOvOcrs3vnHHRdus92kCUGWvD6G2bMwJimqHJKn0FtOwIZvRUi0B3p4RutF7Zp1_cXQBN0HjqjklXl3gRid4K0xIPDA",
    "reciever": "Sx-QgbgH5uE6_R-Ylg2x1dQ3rZsb2v8H8BivVXwpbB4jqaqQb2SYPVS7ua1GiyA26drdErobl_kb5bIn3y405LtklmxEQwo0Ach0zbVkfEQyF_k5qkS3igbx99NN_XTK7jRFk3yka-jub0pLrhdzvFJ5hqyN38ZT55Hap-UEqst1_sypRpwxNZJichKWJEZt8AFx5ClFT23_iZPuLqvNsad-CtQKdGElCbZw4i_Pq4qguBhlbZQL9hsdcRXULoQpk7c=",
    "message": "Do not share your Nullet-ID. Just share reciever id to get nuts."
}

Create reciever address


Any number of receiver addresses can be generated with just one nullet. A receiver can contain a webhook, which receives a POST request from each time it recieves some nuts. We recommend testing the webhook function at webhook.site.


https://api.gudix.net/reciever
POST

nullet string

Nullet ID


webhook string

we send POST Request to this URL when recieving token.

JSON Body:
{
	"nullet": "p48OxschQ6icQzqEkk64B08F23HTxdNl4VV6zxWsTAZ3eUcTzdQaxoZ1CupKk8P7OaZlThC5QL3hVGSYAEhn1UJwb7IwTgYABWeyRSzErDd5pHmtyOmnzPRUf--0hpM1fuVhzhL6NZqmYottoHaSlcf_3oPBQjg91izV-j6reRHq4bsGNj3DbGw3PZkJcRlgG_rn_wpR",
	"webhook": "https://webhook.site/b945870a-4419-4649-a4f0-4332027869bc"
}
Response:
{
    "reciever": "9ZS7UFZjlE9jdR8uBZCgJ8ttusSfvHQDmfz7jdOjbGkxwDzrUBo5oWg_zymqdd7bwjDlloGeYkOvxYAqaFvrNKNSv5XE8WyxfGYCtQehn5IeRm8acXMtpgKTdh7926LEEBBuMKHlyfLsAtOWoreuJhCCKw5yPN2Co-4ZyN-Xr4VwtTiKy_FxHkx4JlKCuG1nPucV6ueJGqxf0Unc1OM6t16IJitgmYW8-VKz9JSN11nmFJFRC0iDwc014jfetbtkh8a3zgQCsv7WFzOLE7NyCoLQ4X6SEi2H55S_PUBZoEYYTOfB-lzw-KaemwxszlAXwwj4AnpTjHuMdWfsoMFea14SwZVKG-3OeQLG2Oiq9PliSPXyyIvynDY5_b2p3ImNRAiw"
}

Send nuts


To send nuts, you need a recipient's reciever address. You cannot send nuts to a nullet id.

Paper
Nuts are digital goods that you can get out of the digital world if necessary. Send the nuts to the reciever gudix_paper and you will get a transaction code that you can print out and bring to safety. The printed-out nuts are like a physical wallet; if you have the paper, you can put the nuts back into the network. You can also provide the paper with a separate password to ensure additional security. Think of it like a bearer share. The one who owns the bearer share can dispose of it.


https://api.gudix.net/sendnuts
POST

sender string

Nullet ID


password string


nuts integer

is required, also for paying invoice to check the correct amount.


reciever string

choose gudix_paper as reciever if you want to store the nuts offline and take it out of the network.


message string

reciever of nuts can read this message


paperpw string

if sending nuts to offline papers you can protect paper with paper password.

JSON Body:
{
    "sender": "bgNPuIUVHuOEZF6OyrLlr2b6Hjtxh5KRqc3Rc7fhMUGFIcnnewVr1TS4PQZisy_7krm4061auEtkptVcfVGTd9ogh8902AsgLQfaaciEGqzUGbsC0lznJQL09at9OOkEcqji9M1PUbGHcjFVtGZqpPfPMeDEOJDf1bQFdrTLRoxpNFhlZxZ96u0I7lxufoy0sHCMaqtg",
    "password": "asdfasdf",
    "reciever": "gudix_paper",
    "nuts": 600,
    "message": "have fun with your Gudix® Nuts"
}
Response:
{
    "transaction": "vNxSkJdIU6W5zKaILcpQ2hHLrZseSBqyqLZHjUocRxkhFainN_-xHyrkmx7JH_vzdXB7MipvceqnboNlE1C6Bb-wWehVVt2tAg3Dio3Z9nf50MbN-rzS4Vd1kC5m9ESB_VjrPXspdDHUHAVCJlZX85BQQ8qnxUmRQXmuTNqXfW6v6bnuEbXu8WJEtdrYyGMXJrn2jM6BVMaEA0cizCnVrxj78TTYIi9uIIgQ0VUg71EmA5tU1XC0VbiIV0Lm2J_KHWZOmOR6bQta-fII8LrOihcbHAd8Bew_-N0_A84SIrdXqdwj2ZiN3psuDCKskKCuGxcYcYriRvoM1EXC0Abv7I0B9PO7pFU_aYlecs79VdNrNrgwdBfXT-_U5K3lg_U9AwiDn8lT98cOcJ4lLJABvcqBNn6OX7C-zLcGhgtzWwXCV4aACXNcig0Of_TIRwwlgbnKSNSkOGhnvZ5zZ_c9iOA6YVp9NL_bRQPB-NGXmyXs6fekZvgB9iuwhUmm47meRiZHNwRojWYsLqx5IJmb2H_w6mc="
}

Invoice


To predefine some data for sending nuts it's possible to create an invoice. The Invoice contains all the necessary data to send token the fast way.


https://api.gudix.net/invoice
POST

reciever string

First you need a reciever address. You can define a webhook with for example an invoice number. If someone pays the invoice we send a POST request to webhook and you get the invoice number back.


nuts integer

nuts definition is optional. If nuts are not defined, the sender can define how many nuts he will pay.


message string


nullet string

just required when creating an invoice as a third party


password string

just required when creating an invoice as a third party

JSON Body for simple invoice WITHOUT appservice:
{
    "reciever": "spQapZoam6ARcHcc8fouBvj2tP5l412oLANEcdiOXml_Qe3kATChS-kjsZYQ51qfXo_m9YEvXUQcEM1P1vrV0GJtbph2g1A-6DDdGvsH4-S80wbstIQUytnGpFDfUVqpzzH8iMDO54QDXFcqjXjbGYL7XM_Ldh5X_dKoGVFtBmoE5DG_z-Ku_q_YK7_GjCD66IcStlUYO6YDkK0Mj4vgwGzpiYwAsbF8a16INjcsG8h6iYvTMB2V3NZxmrz6971VWuJrEnl9nkqTdU4Fx0mc4ufukNzIzSa4CrpNiiOji-q4pwgSCI6pG4it8NM=",
    "nuts": 10,
    "message": "something to write"
}
Response:
{
    "invoice": "AmMSspyerF6L4_vYYV7SbGig_3Gd203csXrFtFKRpFDY5VaagiSsDglfZt8sJV7uRILgve6xuGhF_JiQjwznW62Q0dCVRkK4hScnIoUMOfdpiKsT63yTcqq6os45C0PyJ0wpmdFTLBmuUNG1o3Cv_YdsZJnCF0n8kkPqFzxwT7fj7Qnc4T_3MXma8JsX29tlriF5V7_sg0-RCEH_JX7VW7f3rYSzQer7pFnHW1993CnwxzpXWiZpb6ABVDPMG-eOClk1j4ypI62P8R9ZqXOMHU1X8hsPCL5Hq7mw_j9p9GVfCm7-BHerxaClv-QwdJwrmrUw3n8bWqaR_bm1jWvl92fAM54E1kt69WMSThpXFZBunAKIQJg-f7V1uksOzJ-7ijYahrKoKXLxSL2whFYAXL12NNS8lbyb"
}

Nullet balance


Get all the balances from the nullet


https://api.gudix.net/balance
POST

nullet string

Nullet ID


genesis boolean

get genesis value (only genesis)


genesisdata boolean

get complete genesis data from this nullet

JSON Body:
{
	"nullet": "bgNPuIUVHuOEZF6OyrLlr2b6Hjtxh5KRqc3Rc7fhMUGFIcnnewVr1TS4PQZisy_7krm4061auEtkptVcfVGTd9ogh8902AsgLQfaaciEGqzUGbsC0lznJQL09at9OOkEcqji9M1PUbGHcjFVtGZqpPfPMeDEOJDf1bQFdrTLRoxpNFhlZxZ96u0I7lxufoy0sHCMaqtg",
    "genesis": true
}
Response:
{
    "nuts": 13,
    "xchf": 0,
    "genesis": 0.13943661972,
    "token": {}
}

Paper balance


A paper is a document outside the network. The document was created with Send nuts to "gudix_paper". Comparable to a bearer share.


https://api.gudix.net/paperbalance
POST

paper string

This is the transaction id from sending nuts to the reciever gudix_paper

JSON Body:
{
    "paper": "a2Ld1KK-FnuuOUk9oIMf7SF3QZsjv3Jo4LOt05xL8FUBePxEC6lV5EbMQek6Dhqd_RtzSTBQuV0gX2AxNeSjaJRRAixPO1vCzKMtIRCi2NwA5R0eDxtvqBrWLjVFGEUOasQuDWchAQmwdSNbFaXs7v5e0Ve-T4wAvC9Eoqy5Izm5hU5Dr9mfeL6v8-t6q9wCinr0HkjgSb9U99d4JdP9kzjzUPpgH2fPru9pwlj6JoduzSO4OCUzop9kzqbqjkqgZZnZ3u8hlvgdgCzoYK2OyVwgL6H8ohL3AZ9iOz1XpY6qdm8-2lE5TmTTjXj2V-RUeCTZw3Au0HwlIqRQqHdBO29l4Ikt20t9VGCRYUeQPFz1Sn4cvGO4fKJ5q9fxBu9nCRDBiUiJFxe1qBmT5FFv8QGZ5TUAfYb3X9Ee3ic3E4j_3f4-0LhbkHv4BQuPQSGSsDXP1veV--QzCP8cRvHDf0EZwsY_NdYmEaTnave1-HnirlSej5kP9yhBPWMW4edgX5nKq8rQB7rYvWBFjJeHzf5lj1oh6sKVTimiAlupm0bp8iH0P9PsoAmR22-sX9qHwYdwBbs8Nerq9VFKxdbx-F6wFnoWccN6dY4ta3vnuXSbLtZoT0Lr4dc57xm8jbFZ2-yFqHmCfr9vxUX443Y4U2uCwRrnDNiFoQB4LaUTWy_xMSQIHX_Y8tm7UohVS14Whe1VBIPBr15NWNnLk0YJvkfpgz2Q7DQY4TRd7u09uKgrmeN1yacgOkiiFe5Bss8="
}
Response:
{
    "balance": "600"
}

Create token


To create token, you have to pay at least 1 Nut to encrypt and save your token on the ledger.


https://api.gudix.net/createtoken
POST

nullet string

Nullet ID


password string


tokenid string

the unique token id also called token name.


nuts integer

to encrypt the token and to write in ledger at least 1 Gudix Nut is necessary. The more nuts you put in, the more valuable the token becomes.


quant integer

To split your token you can define a number from 1 to 100'000'000'000 (100 Billions).


reciever string

choose #GENESIS# as reciever if you want to send token to the genesis program.


message string

reciever of nuts can read this message


custom fields string

you can add up to 5 custom fields.

JSON Body:
{
    "nullet": "4KFkQQaPGMpf9SdDn17H6WSPuIRQe4aUzGxPdUDMnjKPnkM-hVC-mhsj0Vo7OC-0MNpEugOSeBpaTfFIfFq97TqBSj_ozxEJCslR_ti_3tPZL2uVstdBZKTPOCHA-u3P9SmBfliOM2kc6345Sc8wdncpmo5abocQk-RgMZwETEhR5Qqubadx_8NhPNtXwI__IRyDnkQh",
	"password": "NicePw",
    "nuts": 10,
    "tokenid": "genix",
    "quant": 100000,
    "custom19": "something I want to encrypt with my token"
}
Response:
{
    "transaction": "Qh1U8XGWG71DGg0A5g9DCG5UQ_bJg3I9XjgTVnXiQTTb_IujSRkRvA5QFOaX2Jr3ihwS4erMMpWrsf_LBwtagYNuM3f64GuFtP9Txr1qyD6NPPBq1V8U95OBc217PhEY_A5Tt7qZrEEvAyFjPyysmRrWcHYOthhAa_e5bT9tIKTMnzIgUsYEuYYoZOB7jTx0nsj0-v7lvb-hzak7byj9LSRs6zzuRbl3xpgVzn2bz3wwuWkSfICtcA4BrtxC1etLoPdjgjlKNGWwCxAc22jRi9BG5I1dNQfapile97dBZPK2nGtCLnTqV5bqWeF3zn940NurzCriX7xo8aFT1EeN2nB3Gn4e16L1R8eNfeQbAciLOKE5aX_yg4yduaTOw4dczUZ3bW-L3xRJ2QHzq8ldJ8bjz8AZsqjpaE1C3MipqODWtOBZuSecfL3yiHFaphyFclCCXmvzZ3Qov75wni4_zRswtmovitKULobK9w27SlO3SzfCbxLo8SXGALDZ7rq1zj6bz9mMW1gKjYuZ9mmOm-VzjPK2VtQ="
}

Top up token


Make a token more valuable. We know the value of Gudix Nuts. When you put more Gudix Nuts to your token, it becomes more valuable. Also you can put in XCHF, the digital Swiss Franc. XCHF is the value of our Gudix Nuts and is the same as a token, just with fixed value. 1 XCHF = 1 CHF


https://api.gudix.net/blowtoken
POST

nullet string

Nullet ID


password string


tokenid string

the unique token id also called token name.


nuts integer

The more nuts you put in, the more valuable the token becomes.


xchf integer

this is integer, but have attention to the quantification. 1 Swiss Franc (CHF) is for the API 1 * 100 * 1'000'000. So if you want to send 1 Swiss Franc you have to send 100000000 XCHF

JSON Body:
{
    "nullet": "4KFkQQaPGMpf9SdDn17H6WSPuIRQe4aUzGxPdUDMnjKPnkM-hVC-mhsj0Vo7OC-0MNpEugOSeBpaTfFIfFq97TqBSj_ozxEJCslR_ti_3tPZL2uVstdBZKTPOCHA-u3P9SmBfliOM2kc6345Sc8wdncpmo5abocQk-RgMZwETEhR5Qqubadx_8NhPNtXwI__IRyDnkQh",
	"password": "NicePw",
    "nuts": 10,
    "tokenid": "genix",
    "nuts": 1
}
Response:
{
    "transaction": "vNxSkJdIU6W5zKaILcpQ2hHLrZseSBqyqLZHjUocRxkhFainN_-xHyrkmx7JH_vzdXB7MipvceqnboNlE1C6Bb-wWehVVt2tAg3Dio3Z9nf50MbN-rzS4Vd1kC5m9ESB_VjrPXspdDHUHAVCJlZX85BQQ8qnxUmRQXmuTNqXfW6v6bnuEbXu8WJEtdrYyGMXJrn2jM6BVMaEA0cizCnVrxj78TTYIi9uIIgQ0VUg71EmA5tU1XC0VbiIV0Lm2J_KHWZOmOR6bQta-fII8LrOihcbHAd8Bew_-N0_A84SIrdXqdwj2ZiN3psuDCKskKCuGxcYcYriRvoM1EXC0Abv7I0B9PO7pFU_aYlecs79VdNrNrgwdBfXT-_U5K3lg_U9AwiDn8lT98cOcJ4lLJABvcqBNn6OX7C-zLcGhgtzWwXCV4aACXNcig0Of_TIRwwlgbnKSNSkOGhnvZ5zZ_c9iOA6YVp9NL_bRQPB-NGXmyXs6fekZvgB9iuwhUmm47meRiZHNwRojWYsLqx5IJmb2H_w6mc="
}

Send token


To send token, you need a recipient's reciever address.


https://api.gudix.net/sendtoken
POST

sender string

Nullet ID


password string


tokenid string

the unique token id also called token name.


quant integer

is required, also for paying invoice to check the correct amount.


reciever string

choose #GENESIS# as reciever if you want to send token to the genesis program.


message string

reciever of nuts can read this message

JSON Body:
{
    "sender": "bgNPuIUVHuOEZF6OyrLlr2b6Hjtxh5KRqc3Rc7fhMUGFIcnnewVr1TS4PQZisy_7krm4061auEtkptVcfVGTd9ogh8902AsgLQfaaciEGqzUGbsC0lznJQL09at9OOkEcqji9M1PUbGHcjFVtGZqpPfPMeDEOJDf1bQFdrTLRoxpNFhlZxZ96u0I7lxufoy0sHCMaqtg",
    "password": "asdfasdf",
    "reciever": "#GENESIS#",
    "tokenid": "MyTesttoken-1dds",
    "quant": 300,
    "message": "the one and only token"
}
Response:
{
    "transaction": "vNxSkJdIU6W5zKaILcpQ2hHLrZseSBqyqLZHjUocRxkhFainN_-xHyrkmx7JH_vzdXB7MipvceqnboNlE1C6Bb-wWehVVt2tAg3Dio3Z9nf50MbN-rzS4Vd1kC5m9ESB_VjrPXspdDHUHAVCJlZX85BQQ8qnxUmRQXmuTNqXfW6v6bnuEbXu8WJEtdrYyGMXJrn2jM6BVMaEA0cizCnVrxj78TTYIi9uIIgQ0VUg71EmA5tU1XC0VbiIV0Lm2J_KHWZOmOR6bQta-fII8LrOihcbHAd8Bew_-N0_A84SIrdXqdwj2ZiN3psuDCKskKCuGxcYcYriRvoM1EXC0Abv7I0B9PO7pFU_aYlecs79VdNrNrgwdBfXT-_U5K3lg_U9AwiDn8lT98cOcJ4lLJABvcqBNn6OX7C-zLcGhgtzWwXCV4aACXNcig0Of_TIRwwlgbnKSNSkOGhnvZ5zZ_c9iOA6YVp9NL_bRQPB-NGXmyXs6fekZvgB9iuwhUmm47meRiZHNwRojWYsLqx5IJmb2H_w6mc="
}

Token data


Get all details from token


https://api.gudix.net/token/:tokenid
GET

tokenid string

Token ID

Example GET Request with Parameters:

	GET https://api.gudix.net/token/testtoken95
Response:
{
    "sender": "bgNPuIUVHuOEZF6OyrLlr2b6Hjtxh5KRqc3Rc7fhMUGFIcnnewVr1TS4PQZisy_7krm4061auEtkptVcfVGTd9ogh8902AsgLQfaaciEGqzUGbsC0lznJQL09at9OOkEcqji9M1PUbGHcjFVtGZqpPfPMeDEOJDf1bQFdrTLRoxpNFhlZxZ96u0I7lxufoy0sHCMaqtg",
    "password": "asdfasdf",
    "reciever": "#GENESIS#",
    "tokenid": "MyTesttoken-1dds",
    "quant": 300,
    "message": "the one and only token",
    "custom19": "something I want to encrypt with my token"
}

Genesis informations


Get a list of all token you sended to genesis and the parameters for calculating daily Gudix Nuts what is earned (harvest). It just can generate full integer nuts and no decimals. If genesis is less than 1, there are no nuts to harvest.


https://api.gudix.net/genesis
POST

Nullet string

Nullet ID

JSON Body:
{
    "nullet": "bgNPuIUVHuOEZF6OyrLlr2b6Hjtxh5KRqc3Rc7fhMUGFIcnnewVr1TS4PQZisy_7krm4061auEtkptVcfVGTd9ogh8902AsgLQfaaciEGqzUGbsC0lznJQL09at9OOkEcqji9M1PUbGHcjFVtGZqpPfPMeDEOJDf1bQFdrTLRoxpNFhlZxZ96u0I7lxufoy0sHCMaqtg",
}
Response:
{
    "xchf": 900000000,
    "nutspriceaverage": 71,
    "nuts": 12.676056338,
    "genesis": 0.25352112676,
    "harvest": 0,
    "data": [
        {
            "id": "608ff1c998646a78183af3f6",
            "token": "Genix2",
            "quant": 100,
            "timestamp": "1620046281662",
            "hash": "004e8a29a8b35acb7660a22345a5c4379c391e46988b8453f91bd3e76d71c4652c8568c2077412b378f52c96247b9bb05ec7c28c8fb56e24a9226fddbb45b904"
        },
        {
            "id": "6090dbb83aaa2460386aef03",
            "token": "Genix2",
            "quant": 999900,
            "timestamp": "1620106168566",
            "hash": "8c8fdf24aa6a08d41ec9619897d84121c917c43e5fcbc88a787fa488eba4c4f8b4e5dd8848d588d087cb011735a2626aa7527f9f80963770662da2de28c8de43"
        }
    ]
}

Cancel genesis


With genesis command you get the ID of each entry. Use the genesis ID to cancel genesis payments. After cancelling the you get back the token back in your nullet.


https://api.gudix.net/cancelgenesis
POST

Nullet string

Nullet ID


id string

genesis ID from command genesis. After cancelling you get back the token immediately.

JSON Body:
{
    "nullet": "bgNPuIUVHuOEZF6OyrLlr2b6Hjtxh5KRqc3Rc7fhMUGFIcnnewVr1TS4PQZisy_7krm4061auEtkptVcfVGTd9ogh8902AsgLQfaaciEGqzUGbsC0lznJQL09at9OOkEcqji9M1PUbGHcjFVtGZqpPfPMeDEOJDf1bQFdrTLRoxpNFhlZxZ96u0I7lxufoy0sHCMaqtg",
    "id": "6090dbb83aaa2460386aef03"
}
Response:
{
    "result": true
}