Skip to content

A Node.js based API for $WORM, and the beginnings of potential future utility.

Notifications You must be signed in to change notification settings

SpaceWormETH/SpaceWorm-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 

Repository files navigation



SpaceWorm API

A Node.js based API for $WORM / SpaceWorm.

Features

  • Circulating supply (total supply - total burned tokens)
  • Total burned
  • Total burned percent
  • Price (USDperWORM, WORMperUSD, ETHperWORM, WORMperETH, USDperETH)
  • Volume (USD or ETH) - currently to hour/block
    • Live-To-Tx Volume
  • Market Cap (USD or ETH)
  • Dashboard Data Output (~started/WIP)

Usage

Circulating Supply

GET https://api.spaceworm.army/v1/circulating-supply
{ "circulatingSupply": "000000000000.000" }

Total Burned

GET https://api.spaceworm.army/v1/total-burned
{ "totalBurned": "000000000000.0000" }

Total Burned as Percent of Starting Supply

GET https://api.spaceworm.army/v1/total-burned-percent
{ "totalBurnedPercent": "00.00" }

Price

Get all options.

GET https://api.spaceworm.army/v1/price
{
  "USDperWORM": "000.00000000000000000",
  "WORMperUSD": "0000.000000000000000",
  "ETHperWORM": "0.00000000000000000000000000000000000",
  "WORMperETH": "00000.00000000000000000000000000",
  "USDperETH": "0000.000000000000000000000000"
}

Get only the requested price.

GET https://api.spaceworm.army/v1/price?n=USDperWORM|WORMperUSD|ETHperWORM|WORMperETH|USDperETH
0.00000000000000001

Volume

Currently pulls from hourly blocks (to be dynamic to each block / timestamp in future).

Get both options

GET https://api.spaceworm.army/v1/24hVolume
{ "volumeETH": "0000.000000000000000000", "volumeUSD": "000000.0000000000" }

Get only the requested currency.

GET https://api.spaceworm.army/v1/24hVolume?currency=eth|usd
{ "ethVolume": "0000.000000000000000000" }
{ "usdVolume": "000000.0000000000" }

Token Details

GET https://api.spaceworm.army/v1/token-details
{
  "contract": "0xf7ecb2e5ddad17506e62f51a442f725a26053fb2",
  "uniswapPairAddress": "0x2c5eae2ac336e27a7c8737cf5fc3263c4f09a2f0",
  "symbol": "$WORM",
  "name": "SpaceWorm",
  "decimals": "18",
  "totalSupply": "1100000"
}
GET https://api.spaceworm.army/v1/total-supply
{ "totalSupply": "1100000" }

Total Holders

GET https://api.spaceworm.army/v1/total-holders
{ "totalHolders": "0000" }

Dashboard (WIP)

Early iteration of part of the API that provides internal data to the dashboard.

Note: this is a Work In Progress (WIP)

GET https://api.spaceworm.army/v1/dashboard
{
  "pair": {
    "token1": {
      "derivedETH": "0.00000000000"
    },
    "reserve0": "000.00000000000",
    "reserve1": "000000.00000000000",
    "reserveUSD": "000000.00000000000",
    "trackedReserveETH": "0000.00000000000",
    "token0Price": "0.00000000000",
    "token1Price": "00000.00000000000",
    "untrackedVolumeUSD": "00000000000.00000000000",
    "volumeToken0": "00000000000.00000000000",
    "volumeToken1": "00000000000.00000000000",
    "txCount": "0000000"
  },
  "pairDayDatas": [
    {
      "id": "0x2c5eae2ac336e27a7c8737cf5fc3263c4f09a2f0-xxxxx",
      "date": 0000000000,
      "dailyVolumeToken0": "0000.00000000000",
      "dailyVolumeToken1": "00000.00000000000",
      "dailyTxns": "0000",
    }
  ],
  "_meta": { "block": { "hash": "0x0000000", "timestamp": "0x0000000" } },
  "volumeETH": "0000.00000000000",
  "volumeUSD": "00000000000.00000000000",
  "totalBurned": "00000.0000000000000000000000",
  "totalBurnedPercent": "0000.00000000000",
  "circulatingSupply": "0000000.00000000000",
  "totalHolders": "0000",
  "USDperWORM": "0.00000000000000000",
  "WORMperUSD": "0.00000000000000",
  "ETHperWORM": "000.0000000000000000",
  "WORMperETH": "000.00000000000",
  "USDperETH": "0000.000000000000000"
}

© 2022 SpaceWorm.army

About

A Node.js based API for $WORM, and the beginnings of potential future utility.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published