Currency

The Currency API allows you to fetch currency data and top holders for a specific currency.

GET/currencies

List all currencies

Retrieves a list of all currencies

Request

GET

/currencies

curl http://localhost:7472/api/v1/currencies

Response

[
  {
    "d073da00-a726-11e9-a874-7de9c8544807": {
      "id": "d073da00-a726-11e9-a874-7de9c8544807",
      "name": "coin",
      "active": true,
      "payout": 5,
      "interval": 5,
      "limit": 1000000,
      "transfer": "Allow",
      "bonus": {},
      "offline": 5,
    }
  },
  {
    "d073da00-a726-11e9-a874-7de9c8544807": {
      "id": "d073da00-a726-11e9-a874-7de9c8544807",
      "name": "pups",
      "active": true,
      "payout": 5,
      "interval": 5,
      "limit": 1000000,
      "transfer": "Allow",
      "bonus": {},
      "offline": 5,
    }
  }
]

GET/currencies/:currencyName

Retrieve a currency

Retrieves a specific currency

URL Parameters

Name
currencyName
Type
string
Description
The name of the currency to retrieve

Request

GET

/currencies/coin

curl http://localhost:7472/api/v1/currencies/coin

Response

{
  "d073da00-a726-11e9-a874-7de9c8544807": {
    "id": "d073da00-a726-11e9-a874-7de9c8544807",
    "name": "coin",
    "active": true,
    "payout": 5,
    "interval": 5,
    "limit": 1000000,
    "transfer": "Allow",
    "bonus": {},
    "offline": 5,
  }
}

GET/currencies/:currencyName/topHolders

Retrieve top holders

Retrieves the top holders of a specific currency

URL Parameters

Name
currencyName
Type
string
Description
The name of the currency to retrieve top holders for

Query Parameters

Name
count
Type
number
Description
The number of top holders to return. Defaults to 10.

Request

GET

/currencies/coin/topHolders

curl http://localhost:7472/api/v1/currencies/coin/topHolders

Response

[
  {
    "username": "fluffypanda",
    "displayName": "FluffyPanda",
    "currency": {
      "d073da00-a726-11e9-a874-7de9c8544807": 281272,
      "3eba5d80-4297-11ee-86eb-d7d7d2938882": 103665
    },
    "_id": "90448736"
  },
  {
    "username": "sparklenova",
    "displayName": "SparkleNova",
    "currency": {
      "d073da00-a726-11e9-a874-7de9c8544807": 281272,
      "3eba5d80-4297-11ee-86eb-d7d7d2938882": 103665
    },
    "_id": "90448726"
  }
]