API docs by Redocly

Grand Pool Blockchain API (1.2.0)

Download OpenAPI specification:

Grand Pool mining pool API for the specified blockchain

pool

Get full pool data

query Parameters
solo
boolean

Show data for solo pool (if pool supports solo mining)?

Responses

Response samples

Content type
application/json
{
  • "info": {
    },
  • "stats": {
    },
  • "network_info": {
    },
  • "slaves": [
    ]
}

Get pool info

Responses

Response samples

Content type
application/json
{
  • "blockchain": "string",
  • "algos": [
    ],
  • "payout_mode": "pplns",
  • "address_format": "normal",
  • "solo": true,
  • "fee": {
    },
  • "payouts_info": {
    },
  • "hardware_type": "asic",
  • "agents": [
    ]
}

Get pool statistics

query Parameters
solo
boolean

Show statistics for solo pool (if pool supports solo mining)?

Responses

Response samples

Content type
application/json
{
  • "miners_count": 0,
  • "workers_count": 0,
  • "hashrate": "string",
  • "avg_hashrate": "string",
  • "blocks_count_24h": 0,
  • "last_found_block_height": 0,
  • "last_found_block_at": "string"
}

Get pool locations

query Parameters
solo
boolean

Show slaves for solo pool (if pool supports solo mining)?

Responses

Response samples

Content type
application/json
{
  • "slaves": [
    ]
}

Get network info

Responses

Response samples

Content type
application/json
{
  • "height": 0,
  • "difficulty": "string",
  • "block_reward": 0
}

miners

Get miners list

query Parameters
limit
required
integer <uint32>
Default: 10

List rows limit

offset
required
integer <uint32>
Default: 0

List rows offset

sorts
string
Example: sorts=address:desc,hashrate:asc,workers_count:desc,blocks_count:asc,solo_blocks_count:desc,joined_at:asc

Miners list sorts

address
string

Miner address filter

hashrate
string
Example: hashrate=1000:100000000

Miner hashrate filter

workers_count
string
Example: workers_count=0:100

Miner workers count filter

blocks_count
string
Example: blocks_count=1:10 or 50

Miner mined blocks count filter

solo_blocks_count
string
Example: solo_blocks_count=1:10 or 50

Miner mined solo blocks count filter

joined_at
string
Example: joined_at=2024-01-01T15:52:01+00:00..2024-02-02

Miner joined at time filter

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "miners": [
    ]
}

Get miner info

path Parameters
miner
required
string

Pool miner

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "hashrate": "string",
  • "workers_count": 0,
  • "blocks_count": 0,
  • "solo_blocks_count": 0,
  • "joined_at": "string",
  • "last_activity": "string"
}

Get miner workers list

path Parameters
miner
required
string

Pool miner

query Parameters
limit
required
integer <uint32>
Default: 10

List rows limit

offset
required
integer <uint32>
Default: 0

List rows offset

sorts
string
Example: sorts=worker:desc,region:asc,agent:desc,solo:asc,hashrate:desc,connected_at:asc

Miner workers list sorts

worker
string

Search worker by name filter

region
string

Miner worker location filter

agent
string

Miner worker agent filter

solo
boolean

Miner worker solo filter

hashrate
string
Example: hashrate=1000:100000000

Miner worker hashrate filter

connected_at
string
Example: connected_at=2024-01-01T15:52:01+00:00..2024-02-02

Miner worker connection time filter

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "workers": [
    ]
}

payouts

Get payouts list

query Parameters
limit
required
integer <uint32>
Default: 10

List rows limit

offset
required
integer <uint32>
Default: 0

List rows offset

sorts
string
Example: sorts=miner:desc,tx_hash:asc,amount:desc,paid_at:asc

Payouts list sorts

miner
string

Payout miner address filter

tx_hash
string

Payout transaction hash filter

amount
string
Example: amount=1000:2000000

Payout amount filter

paid_at
string
Example: paid_at=2024-01-01T15:52:01+00:00..2024-02-02

Payout time filter

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "payouts": [
    ]
}

Get miner balance

path Parameters
miner
required
string

Pool miner

Responses

Response samples

Content type
application/json
{
  • "miner": {
    },
  • "balance": 0
}

blocks

Get blocks list

query Parameters
limit
required
integer <uint32>
Default: 10

List rows limit

offset
required
integer <uint32>
Default: 0

List rows offset

sorts
string
Example: sorts=miner:desc,miner_hashrate:asc,block_height:desc,block_hash:asc,round_miners_count:desc,mined_at:asc

Blocks list sorts

miner
string

Mined block miner address filter

miner_hashrate
string
Example: miner_hashrate=1000:100000000

Mined block miner hashrate filter

block_height
string
Example: block_height=10000 or 50000:100000

Mined block height filter

block_hash
string

Mined block hash filter

round_miners_count
string
Example: round_miners_count=500 or 100:1000

Round miners count filter

mined_at
string
Example: mined_at=2024-01-01T15:52:01+00:00..2024-02-02

Mined block time filter

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "blocks": [
    ]
}

Get solo blocks list

query Parameters
limit
required
integer <uint32>
Default: 10

List rows limit

offset
required
integer <uint32>
Default: 0

List rows offset

sorts
string
Example: sorts=miner:desc,miner_hashrate:asc,block_height:desc,block_hash:asc,reward:desc,tx_hash:asc,paid_at:desc,mined_at:asc

Solo blocks list sorts

miner
string

Mined solo block miner address filter

miner_hashrate
string
Example: miner_hashrate=1000:100000000

Mined solo block miner hashrate filter

block_height
string
Example: block_height=10000 or 50000:100000

Mined solo block height filter

block_hash
string

Mined solo block hash filter

reward
string
Example: reward=999:99999999

Mined solo block reward filter

tx_hash
string

Mined solo block transaction hash filter

paid_at
string
Example: paid_at=2024-01-01T15:52:01+00:00..2024-02-02

Solo block reward payment time filter

mined_at
string
Example: mined_at=2024-01-01T15:52:01+00:00..2024-02-02

Solo block mining time filter

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "blocks": [
    ]
}

charts

Get pool stats chart points

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

solo
boolean

Show pool solo stats points (if pool supports solo mining)?

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}

Get network difficulties chart points

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}

Get rounds chart points

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}

Get miner profitabilities chart points

path Parameters
miner
required
string

Pool miner

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}

Get miner hashrates chart points

path Parameters
miner
required
string

Pool miner

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

solo
boolean

Show miner solo hashrates points (if pool supports solo mining)?

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}

Get miner shares chart points

path Parameters
miner
required
string

Pool miner

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}

Get miner worker hashrates chart points

path Parameters
miner
required
string

Pool miner

worker
required
string

Pool worker

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}

Get miner worker shares chart points

path Parameters
miner
required
string

Pool miner

worker
required
string

Pool worker

query Parameters
period
required
string (ChartPeriod)
Enum: "hour" "day" "week" "month"

Chart period

Responses

Response samples

Content type
application/json
{
  • "points": [
    ]
}