Skip to content

Instantly share code, notes, and snippets.

@alxdrlitreev
Created January 21, 2024 02:07
Show Gist options
  • Save alxdrlitreev/ca5937a4eb3e85b14282e9e1932ef98a to your computer and use it in GitHub Desktop.
Save alxdrlitreev/ca5937a4eb3e85b14282e9e1932ef98a to your computer and use it in GitHub Desktop.
Plan Wizard

BASED PlanWizard

Endpoint: https://planwizard.basedapps.co.uk/

NB! DO NOT rely on this API, it is for demo purposes only and it WILL be changed soon.

Methods

GET /nodes?limit=100&offset=0

Returns information about all nodes available on chain

Example:

{
    "data": [
        {
            "id": 848,
            "is_active": true,
            "revision": 1705802068,
            "is_node_status_fetched": true,
            "last_node_status_fetch": "2024-01-21T02:00:47.99249Z",
            "is_network_info_fetched": false,
            "last_network_info_fetch": null,
            "is_health_checked": false,
            "last_health_check": null,
            "address": "sentnode1zzpragl7n6yuh7kkawk2cj895x4h039wf2hgna",
            "remote_url": "https://23.231.78.40:33763",
            "status": 1,
            "status_at": "2024-01-21T01:06:10.540593Z",
            "inactive_at": "2024-01-21T02:06:10.540593Z",
            "gigabyte_prices": [
                {
                    "denom": "ibc/31FEE1A2A9F9C01113F90BD0BBCCE8FD6BBB8585FAF109A2101827DD1D5B95B8",
                    "amount": 52573
                },
                {
                    "denom": "ibc/A8C2D23A1E6F95DA4E48BA349667E322BD7A6C996D8A4AAE8BA72E190F3D1477",
                    "amount": 9204
                },
                {
                    "denom": "ibc/B1C0DDB14F25279A2026BC8794E12B259F8BDA546A3C5132CCAEE4431CE36783",
                    "amount": 1180852
                },
                {
                    "denom": "ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518",
                    "amount": 122740
                },
                {
                    "denom": "udvpn",
                    "amount": 15342624
                }
            ],
            "hourly_prices": [
                {
                    "denom": "ibc/31FEE1A2A9F9C01113F90BD0BBCCE8FD6BBB8585FAF109A2101827DD1D5B95B8",
                    "amount": 18480
                },
                {
                    "denom": "ibc/A8C2D23A1E6F95DA4E48BA349667E322BD7A6C996D8A4AAE8BA72E190F3D1477",
                    "amount": 770
                },
                {
                    "denom": "ibc/B1C0DDB14F25279A2026BC8794E12B259F8BDA546A3C5132CCAEE4431CE36783",
                    "amount": 1871892
                },
                {
                    "denom": "ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518",
                    "amount": 18897
                },
                {
                    "denom": "udvpn",
                    "amount": 4160000
                }
            ],
            "moniker": "DreamMaker_UUgx77",
            "bandwidth_upload": 253875000,
            "bandwidth_download": 317750000,
            "is_handshake_enabled": false,
            "handshake_peers": 8,
            "interval_set_sessions": 10000000000,
            "interval_update_sessions": 6900000000000,
            "interval_update_status": 3300000000000,
            "location_city": "Los Angeles",
            "location_country": "United States",
            "location_lat": 34.0726,
            "location_lon": -118.261,
            "operator": "sent1zzpragl7n6yuh7kkawk2cj895x4h039wluk3kt",
            "peers": 1,
            "max_peers": 250,
            "type": 2,
            "version": "0.7.1",
            "asn": null,
            "is_residential": null,
            "is_healthy": null
        },
        {
            "id": 851,
            "is_active": true,
            "revision": 1705802068,
            "is_node_status_fetched": true,
            "last_node_status_fetch": "2024-01-21T02:00:49.209966Z",
            "is_network_info_fetched": false,
            "last_network_info_fetch": null,
            "is_health_checked": false,
            "last_health_check": null,
            "address": "sentnode1zzfh0ul0eqe8w3m9w8uf94vnycqkdc3egncvke",
            "remote_url": "https://5.231.206.140:6636",
            "status": 1,
            "status_at": "2024-01-21T01:50:34.065488Z",
            "inactive_at": "2024-01-21T02:50:34.065488Z",
            "gigabyte_prices": [
                {
                    "denom": "ibc/31FEE1A2A9F9C01113F90BD0BBCCE8FD6BBB8585FAF109A2101827DD1D5B95B8",
                    "amount": 52573
                },
                {
                    "denom": "ibc/A8C2D23A1E6F95DA4E48BA349667E322BD7A6C996D8A4AAE8BA72E190F3D1477",
                    "amount": 9204
                },
                {
                    "denom": "ibc/B1C0DDB14F25279A2026BC8794E12B259F8BDA546A3C5132CCAEE4431CE36783",
                    "amount": 1180852
                },
                {
                    "denom": "ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518",
                    "amount": 122740
                },
                {
                    "denom": "udvpn",
                    "amount": 15342624
                }
            ],
            "hourly_prices": [
                {
                    "denom": "ibc/31FEE1A2A9F9C01113F90BD0BBCCE8FD6BBB8585FAF109A2101827DD1D5B95B8",
                    "amount": 18480
                },
                {
                    "denom": "ibc/A8C2D23A1E6F95DA4E48BA349667E322BD7A6C996D8A4AAE8BA72E190F3D1477",
                    "amount": 770
                },
                {
                    "denom": "ibc/B1C0DDB14F25279A2026BC8794E12B259F8BDA546A3C5132CCAEE4431CE36783",
                    "amount": 1871892
                },
                {
                    "denom": "ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518",
                    "amount": 18897
                },
                {
                    "denom": "udvpn",
                    "amount": 4160000
                }
            ],
            "moniker": "SuchNode-mSqmIz3JcC0j",
            "bandwidth_upload": 116383225,
            "bandwidth_download": 117330675,
            "is_handshake_enabled": false,
            "handshake_peers": 8,
            "interval_set_sessions": 10000000000,
            "interval_update_sessions": 6900000000000,
            "interval_update_status": 3300000000000,
            "location_city": "Bad Soden am Taunus",
            "location_country": "Germany",
            "location_lat": 50.1592,
            "location_lon": 8.48173,
            "operator": "sent1zzfh0ul0eqe8w3m9w8uf94vnycqkdc3e79e4n0",
            "peers": 0,
            "max_peers": 250,
            "type": 2,
            "version": "0.7.1",
            "asn": null,
            "is_residential": null,
            "is_healthy": null
        }
    ]
}

GET /nodes/:address

Returns information about node with specified blockchain address

Example:

{
    "data": {
        "id": 848,
        "is_active": true,
        "revision": 1705802068,
        "is_node_status_fetched": true,
        "last_node_status_fetch": "2024-01-21T02:00:47.99249Z",
        "is_network_info_fetched": false,
        "last_network_info_fetch": null,
        "is_health_checked": false,
        "last_health_check": null,
        "address": "sentnode1zzpragl7n6yuh7kkawk2cj895x4h039wf2hgna",
        "remote_url": "https://23.231.78.40:33763",
        "status": 1,
        "status_at": "2024-01-21T01:06:10.540593Z",
        "inactive_at": "2024-01-21T02:06:10.540593Z",
        "gigabyte_prices": [
            {
                "denom": "ibc/31FEE1A2A9F9C01113F90BD0BBCCE8FD6BBB8585FAF109A2101827DD1D5B95B8",
                "amount": 52573
            },
            {
                "denom": "ibc/A8C2D23A1E6F95DA4E48BA349667E322BD7A6C996D8A4AAE8BA72E190F3D1477",
                "amount": 9204
            },
            {
                "denom": "ibc/B1C0DDB14F25279A2026BC8794E12B259F8BDA546A3C5132CCAEE4431CE36783",
                "amount": 1180852
            },
            {
                "denom": "ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518",
                "amount": 122740
            },
            {
                "denom": "udvpn",
                "amount": 15342624
            }
        ],
        "hourly_prices": [
            {
                "denom": "ibc/31FEE1A2A9F9C01113F90BD0BBCCE8FD6BBB8585FAF109A2101827DD1D5B95B8",
                "amount": 18480
            },
            {
                "denom": "ibc/A8C2D23A1E6F95DA4E48BA349667E322BD7A6C996D8A4AAE8BA72E190F3D1477",
                "amount": 770
            },
            {
                "denom": "ibc/B1C0DDB14F25279A2026BC8794E12B259F8BDA546A3C5132CCAEE4431CE36783",
                "amount": 1871892
            },
            {
                "denom": "ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518",
                "amount": 18897
            },
            {
                "denom": "udvpn",
                "amount": 4160000
            }
        ],
        "moniker": "DreamMaker_UUgx77",
        "bandwidth_upload": 253875000,
        "bandwidth_download": 317750000,
        "is_handshake_enabled": false,
        "handshake_peers": 8,
        "interval_set_sessions": 10000000000,
        "interval_update_sessions": 6900000000000,
        "interval_update_status": 3300000000000,
        "location_city": "Los Angeles",
        "location_country": "United States",
        "location_lat": 34.0726,
        "location_lon": -118.261,
        "operator": "sent1zzpragl7n6yuh7kkawk2cj895x4h039wluk3kt",
        "peers": 1,
        "max_peers": 250,
        "type": 2,
        "version": "0.7.1",
        "asn": null,
        "is_residential": null,
        "is_healthy": null
    }
}

GET /nodes/:address/plans

Get information about enrollment of the node on plans managed via current instance of Plan Wizard.

Example:

{
    "data": [
        {
            "id": 1,
            "name": "General",
            "blockchain_id": 6,
            "is_managed_automatically": true
        }
    ]
}

GET /plans

Get information about all plans managed on this instance of Plan Wizard.

Example:

{
    "data": [
        {
            "id": 1,
            "name": "General",
            "blockchain_id": 6,
            "is_managed_automatically": true
        }
    ]
}

GET /plans/:id

Get information about specific plan

Example:

{
    "data": {
        "id": 1,
        "name": "General",
        "blockchain_id": 6,
        "is_managed_automatically": true
    }
}

GET /plans/:id/rules

Get information about node listing rules of specific plan

Example:

{
    "data": [
        {
            "id": 2,
            "plan_id": 1,
            "is_active": true,
            "min_gigabyte_prices": null,
            "max_gigabyte_prices": null,
            "min_hourly_prices": null,
            "max_hourly_prices": [
                {
                    "denom": "udvpn",
                    "amount": 4160000
                }
            ],
            "should_be_residential": false,
            "node_type": null,
            "min_bandwidth_upload": null,
            "max_bandwidth_upload": null,
            "min_bandwidth_download": null,
            "max_bandwidth_download": null
        }
    ]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment