SIAFRENCH API README

An API build to help you to interact with Sia network without deploy node
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation and Running example
   • Available Scripts
3. Usage
4. Roadmap
5. References
6. Contributing

About The Project

Siafrench APIs provide a way for different software systems to interact with the SIA Network and easily retrieve Data without depoying a new node. It’s allowing developers to build new applications and services on top of the Sia Network. APIs can be used to access onchain data, file managing fonctionnality, or services from other applications, and can be built using a variety of programming languages and technologies.

(back to top)

Getting Started

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.
• Node.js - Download & Install Node.js and the npm package manager.

(back to top)

Installation and Running example

> npm install
> npm start

(back to top)

Now the API is available using http://localhost:4000

Available Scripts

Before starting the project, it is necessary to create an .env file based on the .env.temp file.

After that, in the project directory, you can run:

npm start

Runs the app in the production mode.
Use http://localhost:4000 to access to plugin.

You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

(back to top)

Usage

Before using this API, you must install and Sia node to contact Sia network (Installation instruction)

Then use the following endpoints before accessing the plugins :

GET /networkpower/storagestate

Get all storage state

//Example
curl --location 'localhost:4000/networkpower/storagestate'

Response

{
    "request_id": "f1c9f510-bb22-4cdb-83c2-f501506cacab",
    "code": 0,
    "message": "success.",
    "data": {
        "totalnetworkstorage": 35190546104320,
        "usednetworkstorage": 35188700610560,
        "currentblockchainheight": 7450,
        "timestamp": 1678878089759
    }
}

GET /networkpower/activeshosts

Retrieve Active hosts on the network

//Example
curl --location '34.214.46.107:4000/networkpower/activeshosts'

Response

{
    "request_id": "e4e6fa8e-8ca6-499c-a4e9-3f778959e0a2",
    "code": 0,
    "message": "success.",
    "data": {
        "numberactivestorage": 11,
        "numberactivestorageACC": 11,
        "currentblockchainheight": 7450,
        "timestamp": 1678878228767
    }
}

GET /networkpower/hostshistory

Retrieve hosts history and last top sia hosts

//Example
curl --location '34.214.46.107:4000/networkpower/hostshistory'

Response

{
    "request_id": "b3c94344-dd20-4f2e-b06b-107aea34cacb",
    "code": 0,
    "message": "success.",
    "data": {
        "topSiaHosts": {
            "N1": {
                "totalstorage": 22999994466304,
                "netaddress": "siabucket4711.ddns.net"
            },
            "N2": {
                "totalstorage": 10752001835008,
                "netaddress": "sia-test.kuriyasu.net"
            },
            "N3": {
                "totalstorage": 10000000876544,
                "netaddress": "185.200.116.131"
            }
        },
        "hostsHistory": [
            [
                {
                    "activeHostsNumber": 23,
                    "timestamp": 1713118200543
                }
            ]
        ]
    }
}

GET /networkpower/usageratio

Get current usage ratio of the network

//Example
curl --location 'localhost:4000/networkpower/usageratio'

Response

{
    "request_id": "79a703e3-b126-41c2-9416-0fffa001cbd5",
    "code": 0,
    "message": "success.",
    "data": {
        "storageusagepercentage": 1,
        "averagestoragesizeperhost": 3199140554938.1816,
        "currentblockchainheight": 7450,
        "timestamp": 1678878309701
    }
}

GET /networkeconomics/miningprofitability

Get network mining profitability of your node

//Example
 curl --location 'localhost:4000/networkeconomics/miningprofitability'

Response

{
    "request_id": "77eabb6d-f89b-4cb4-b0f4-7bd8c3b9b20a",
    "code": 0,
    "message": "success.",
    "data": {
        "currentprofitabilitybymhs": 165009189.502976,
        "currentblockchainheight": 434136,
        "timestamp": 1694089570717,
        "latestminingblockrewards": [
            {
                "value": "30001742610000000000000000000",
                "unlockhash": "9fbe5e0e17cbaab13a8d0a56c33f32222fc48c9512565184401dea648e786db4cc078b90d8f5"
            }
        ]
    }
}

GET /networkeconomics/totalsupply

Get network totalsupply of your node

//Example
 curl --location 'localhost:4000/networkeconomics/totalsupply'

Response

{
    "request_id": "9568e540-f9fc-4eec-9401-68a19c73aa9c",
    "code": 0,
    "message": "success.",
    "data": {
        "totalsiacoinincirculation": 9.465600819904237e+33,
        "totalburntsiacoin": 8.339849238018064e+30,
        "currentblockchainheight": 31553,
        "timestamp": 1692662358837
    }
}

GET /networkeconomics/profitspaidbyrenters

Get network profits paid by renters of your node

//Example
 curl --location 'localhost:4000/networkeconomics/profitspaidbyrenters'

Response

{
    "request_id": "48458aec-dd4e-4c85-95fe-5eaf318932a6",
    "code": 0,
    "message": "success.",
    "data": {
        "Network_profits_24hrs": 1.1267912515097893e+24,
        "Network_profits_7days": 2.0912262247755924e+28,
        "Network_profits_30days": 1.4152292097427778e+29,
        "timestamp": 1692662358837
    }
}

GET /networkeconomics/siafundprofitability

Get network Siafund profitability of your node

//Example
 curl --location 'localhost:4000/networkeconomics/siafundprofitability'

Response

{
    "request_id": "48458aec-dd4e-4c85-95fe-5eaf318932a6",
    "code": 0,
    "message": "success.",
    "data": {
        "Network_profits_24hrs": 1.1267912515097893e+24,
        "Network_profits_7days": 2.0912262247755924e+28,
        "Network_profits_30days": 1.4152292097427778e+29,
        "timestamp": 1692662358837
    }
}

GET /networkmining/miningtotalhashrate

Get network mining total hash rate of your node

//Example
 curl --location 'localhost:4000/networkmining/miningtotalhashrate'

Response

{
    "request_id": "b3582a0c-0eab-4a52-a5dc-c3e1e9bf133a",
    "code": 0,
    "message": "success.",
    "data": {
        "currentnetworkmininghashrate": 1.3285950102336483e+26,
        "currentnetworkdifficulty": "16543376526631299275",
        "currentaverageblocktime": 534.8,
        "currentheight": 434136,
        "timestamp": 1694091301459
    }
}

GET /networkmining/miningdifficulty

Get network mining difficulty of your node

//Example
 curl --location 'localhost:4000/networkmining/miningdifficulty'

Response

{
    "request_id": "ec63dcb1-99f8-4550-b5dc-c748ed4bed8e",
    "code": 0,
    "message": "success.",
    "data": {
        "currentminingdifficulty": "16543376526631299275",
        "currentminingblockreward": "30001742610000000000000000000",
        "currentheight": 434136,
        "timestamp": 1694091355736
    }
}

GET /networkstoragemarketplace/storagepricing

Get network mining difficulty of your node

//Example
 curl --location 'localhost:4000/networkstoragemarketplace/storagepricing'

Response

{
    "request_id": "be1a9708-7ce6-411a-b5b8-c6939ce8ee80",
    "code": 0,
    "message": "success.",
    "data": {
        "storagepriceperTbpermonth": null,
        "uploadpriceperTB": null,
        "dowloadpriceperTB": null,
        "timestamp": 1694092002789
    }
}

(back to top)

Roadmap

• Add back to top links
• Add Changelog
• Add new features
  • Add Network Storage State route
  • Add Network Actives Hosts route
  • Add Network Usage Ratio route
  • Add Network Mining Profitability
  • Add Network Profits paid by renters route
  • Add Network Total Supply route
  • Add Network Siafund Profitability route
  • Add Network Siafund Distribution route
  • Add Network Storage Pricing route
  • Add Network Storage contract route
  • Add Network Curent distribution route

See the open issues for a full list of proposed features (and known issues).

(back to top)

References

• Documentation:
  • SIA API

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are

greatly appreciated.

1. Fork the SiaFrench Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -a -m 'feat: add some amazing feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

(back to top)