API | Planets RAW

Planets - The Public BloqVerse API


We provide the following bloqverse specific functions through our planets API endpoint:

  • atom - returns an object containing specific atom details
  • atoms - returns an array of all available atoms and their details
  • player - returns an object containing player specific information
  • universe - returns an object containing general universal information

In its current beta state - by default, these functions will check the private bce network.

You may also add the chain parameter in order to select the public network.

Required options should be set via GET params and piped if using URLs - for example - ?params=option_one|option_two

More information on each of the available methods can be seen below:


Important

The planets API end-points utilize caching by default. Each unique URL is cached for several minutes. If the same API URL is accessed within that time, the life of that cache is repeatedly renewed until it is not accessed within its limits. To ensure that an API request does not utilize cached results simply add the &cache=off parameter within the URL request.


atom ( symbol , address )


A valid atomic symbol is required and a valid Ethereum address is optional.

The atom function is used to provide details specific to a single atom.


An example URL request:

http://bloqverse.com/api/cortex/v1/planets?method=atom&params=Kr

Data returned should look similar to this:

"results": 
{
    "index": 36,
    "density": 375,
    "symbol": "Kr",
    "name": "Krypton",
    "type": "non-metal",
    "price": 33000,
    "supply": 177
}

Adding the optional address parameter will check for and add the available balance:

http://bloqverse.com/api/cortex/v1/planets?method=atom&params=Kr&address=0xf88d2b4319c10197499f3f9b35f6008f0631dac6

"results": 
{
    "index": 36,
    "density": 375,
    "symbol": "Kr",
    "name": "Krypton",
    "type": "non-metal",
    "price": 33000,
    "supply": 177,
    "balance": 10
}

atoms ( address )


A valid Ethereum address is optional.

Providing one will also check the balance of the supplied address for each available atom.


An example URL request:

http://bloqverse.com/api/cortex/v1/planets?method=atoms&params=0xf88d2b4319c10197499f3f9b35f6008f0631dac6

Data returned should look similar to this:

"results": 
[
    {
        "index": 1,
        "density": 9,
        "symbol": "H",
        "name": "Hydrogen",
        "type": "non-metal",
        "price": 550,
        "supply": 5622,
        "balance": 5322
    },
    {
        "index": 2,
        "density": 18,
        "symbol": "He",
        "name": "Helium",
        "type": "non-metal",
        "price": 5200,
        "supply": 199950,
        "balance": 99950
    },
    {
        "index": 3,
        "density": 53,
        "symbol": "Li",
        "name": "Lithium",
        "type": "metal",
        "price": 27000,
        "supply": 69874,
        "balance": 34900
    },
    {
        "index": 4,
        "density": 185,
        "symbol": "Be",
        "name": "Beryllium",
        "type": "metal",
        "price": 748000,
        "supply": 258,
        "balance": 258
    },
    {
        "index": 5,
        "density": 234,
        "symbol": "B",
        "name": "Boron",
        "type": "metaloid",
        "price": 1114000,
        "supply": 204,
        "balance": 204
    },
    {
        "index": 6,
        "density": 226,
        "symbol": "C",
        "name": "Carbon",
        "type": "non-metal",
        "price": 2400,
        "supply": 211,
        "balance": 211
    },
    {
        "index": 7,
        "density": 125,
        "symbol": "N",
        "name": "Nitrogen",
        "type": "non-metal",
        "price": 350,
        "supply": 383,
        "balance": 383
    },
    {
        "index": 8,
        "density": 143,
        "symbol": "O",
        "name": "Oxygen",
        "type": "non-metal",
        "price": 300,
        "supply": 334,
        "balance": 334
    },
    {
        "index": 9,
        "density": 170,
        "symbol": "F",
        "name": "Fluorine",
        "type": "non-metal",
        "price": 190000,
        "supply": 281,
        "balance": 281
    },
    {
        "index": 10,
        "density": 90,
        "symbol": "Ne",
        "name": "Neon",
        "type": "non-metal",
        "price": 33000,
        "supply": 532,
        "balance": 532
    },
    {
        "index": 11,
        "density": 97,
        "symbol": "Na",
        "name": "Sodium",
        "type": "metal",
        "price": 25000,
        "supply": 493,
        "balance": 493
    },
    {
        "index": 12,
        "density": 174,
        "symbol": "Mg",
        "name": "Magnesium",
        "type": "metal",
        "price": 580,
        "supply": 275,
        "balance": 275
    },
    {
        "index": 13,
        "density": 270,
        "symbol": "Al",
        "name": "Aluminum",
        "type": "metal",
        "price": 200,
        "supply": 200177,
        "balance": 100177
    },
    {
        "index": 14,
        "density": 233,
        "symbol": "Si",
        "name": "Silicon",
        "type": "metaloid",
        "price": 250,
        "supply": 205,
        "balance": 205
    },
    {
        "index": 15,
        "density": 182,
        "symbol": "P",
        "name": "Phosphorus",
        "type": "non-metal",
        "price": 30000,
        "supply": 263,
        "balance": 263
    },
    {
        "index": 16,
        "density": 207,
        "symbol": "S",
        "name": "Sulfur",
        "type": "non-metal",
        "price": 50000,
        "supply": 231,
        "balance": 231
    },
    {
        "index": 17,
        "density": 321,
        "symbol": "Cl",
        "name": "Chlorine",
        "type": "non-metal",
        "price": 150,
        "supply": 149,
        "balance": 149
    },
    {
        "index": 18,
        "density": 178,
        "symbol": "Ar",
        "name": "Argon",
        "type": "non-metal",
        "price": 500,
        "supply": 269,
        "balance": 269
    },
    {
        "index": 19,
        "density": 86,
        "symbol": "K",
        "name": "Potassium",
        "type": "metal",
        "price": 100000,
        "supply": 556,
        "balance": 556
    },
    {
        "index": 20,
        "density": 155,
        "symbol": "Ca",
        "name": "Calcium",
        "type": "metal",
        "price": 20000,
        "supply": 309,
        "balance": 309
    },
    {
        "index": 21,
        "density": 299,
        "symbol": "Sc",
        "name": "Scandium",
        "type": "metal",
        "price": 1000000,
        "supply": 160,
        "balance": 160
    },
    {
        "index": 22,
        "density": 454,
        "symbol": "Ti",
        "name": "Titanium",
        "type": "metal",
        "price": 1000,
        "supply": 105,
        "balance": 105
    },
    {
        "index": 23,
        "density": 611,
        "symbol": "V",
        "name": "Vanadium",
        "type": "metal",
        "price": 1500,
        "supply": 78,
        "balance": 78
    },
    {
        "index": 24,
        "density": 719,
        "symbol": "Cr",
        "name": "Chromium",
        "type": "metal",
        "price": 900,
        "supply": 66,
        "balance": 66
    },
    {
        "index": 25,
        "density": 743,
        "symbol": "Mn",
        "name": "Manganese",
        "type": "metal",
        "price": 580,
        "supply": 64,
        "balance": 64
    },
    {
        "index": 26,
        "density": 787,
        "symbol": "Fe",
        "name": "Iron",
        "type": "metal",
        "price": 5,
        "supply": 560,
        "balance": 60
    },
    {
        "index": 27,
        "density": 890,
        "symbol": "Co",
        "name": "Cobalt",
        "type": "metal",
        "price": 9300,
        "supply": 53,
        "balance": 53
    },
    {
        "index": 28,
        "density": 890,
        "symbol": "Ni",
        "name": "Nickel",
        "type": "metal",
        "price": 5500,
        "supply": 53,
        "balance": 53
    },
    {
        "index": 29,
        "density": 896,
        "symbol": "Cu",
        "name": "Copper",
        "type": "metal",
        "price": 880,
        "supply": 53,
        "balance": 53
    },
    {
        "index": 30,
        "density": 713,
        "symbol": "Zn",
        "name": "Zinc",
        "type": "metal",
        "price": 450,
        "supply": 67,
        "balance": 67
    },
    {
        "index": 31,
        "density": 591,
        "symbol": "Ga",
        "name": "Gallium",
        "type": "metal",
        "price": 52500,
        "supply": 81,
        "balance": 81
    },
    {
        "index": 32,
        "density": 532,
        "symbol": "Ge",
        "name": "Germanium",
        "type": "metaloid",
        "price": 170000,
        "supply": 90,
        "balance": 90
    },
    {
        "index": 33,
        "density": 572,
        "symbol": "As",
        "name": "Arsenic",
        "type": "metaloid",
        "price": 150,
        "supply": 83,
        "balance": 83
    },
    {
        "index": 34,
        "density": 479,
        "symbol": "Se",
        "name": "Selenium",
        "type": "non-metal",
        "price": 28000,
        "supply": 19996145,
        "balance": 9996145
    },
    {
        "index": 35,
        "density": 312,
        "symbol": "Br",
        "name": "Bromine",
        "type": "non-metal",
        "price": 5000,
        "supply": 153,
        "balance": 153
    },
    {
        "index": 36,
        "density": 375,
        "symbol":"Kr",
        "name":"Krypton",
        "type":"non-metal",
        "price":33000,
        "supply":177,
        "balance":127
    }
]

player ( address )


A valid Ethereum address is required.

The player function is used to provide details specific to a single player.


An example URL request:

http://bloqverse.com/api/cortex/v1/planets?method=player&params=0xf88d2b4319c10197499f3f9b35f6008f0631dac6

Data returned should look similar to this:

"results": 
{
    "name": "Floyd Flinkle Flimble Flop",
    "dna": "16518405519665313984359114976854961977074425395541704574309444930411251557139",
    "age": 88140,
    "planet": 
    {
        "birth": "Smallville",
        "current": "Smallville"
    },
    "travel":
    {
        "jumps": 0,
        "distance": 0
    },
    "mothered": 2,
    "fathered": 2,
    "children":
    [
        {
            "name": "Zark",
            "age": 74817,
            "mother": "Floyd Flinkle Flimble Flop",
            "father": "FooFoo"
        },
        {
            "name": "Kraz",
            "age": 74804,
            "mother": "Floyd Flinkle Flimble Flop",
            "father": "FooFoo"
        }
    ],
    "corporations": false,
    "ally": false,
    "spouse":
    {
        "address": "0x8a0add80dd4b579d28a36ce1745fe45753980770",
        "name": "FooFoo",
        "age": 85450,
        "planets": 4
    },
    "planets":
    [
        {
            "age": 136438,
            "players": 2,
            "x": 5,
            "y": 3,
            "z": 79,
            "name": "Smallville"
        },
        {
            "age": 94741,
            "players": 0,
            "x": 22,
            "y": 22,
            "z": 22,
            "name": "Colt"
        },
        {
            "age": 94548,
            "players": 0,
            "x": 11,
            "y": 22,
            "z": 33,
            "name": "Obviiious III"
        },
        {
            "age": 94533,
            "players": 0,
            "x": 33,
            "y": 22,
            "z": 11,
            "name": "Obviiious IV"
        }
    ],
    "milestones":
    {
        "home": false,
        "shop": false,
        "factory": false,
        "car": false,
        "boat": false,
        "spaceship": false,
        "powerplant": false,
        "mine": false,
        "lab": false
    },
    "things":
    {
        "buildings": 0,
        "children": 2,
        "corporations": 0,
        "credits": 17807603,
        "energy": 229046846,
        "gems": 0,
        "generators": 0,
        "magnets": 0,
        "planets": 4,
        "plasma": 0,
        "soil": 0,
        "steel": 0,
        "stone": 0,
        "transportation": 0,
        "water": 0,
        "wood": 0
    }
}

universe ( )


This function does not have any options, but will return general universal information.


An example URL request:

http://bloqverse.com/api/cortex/v1/planets?method=universe

Data returned should look similar to this:

"results":
{
    "bank":
    {
        "credits": 242199692,
        "energy": 9729245275286310
    },
    "buildings":
    {
        "individuals": 3,
        "corporations": 0,
        "deconstructed": 0
    },
    "children": 4,
    "players": 5,
    "corporations": 0,
    "generators":
    {
        "individuals": 3,
        "corporations": 0,
        "deconstructed": 0
    },
    "planets":
    {
        "discovered": 16,
        "undiscovered": 999984
    },
    "transportation":
    {
        "individuals": 3,
        "corporations": 0,
        "deconstructed": 0
    },
    "universe":
    {
        "name": "bloqverse.com",
        "credits": 962694922,
        "energy": 9729245511005278,
        "employees": 0,
        "unemployed": 9
    }
}

Table of Contents