Hive Civilization · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Thehiveryiq Com Mining API
9 actions
9 updates
phrasing
extends
openapi/thehiveryiq-com-mining-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/v1/mining/scan'].get
$.paths['/v1/mining/route'].post
$.paths['/v1/mining/book'].post
$.paths['/v1/mining/pnl'].get
$.paths['/v1/mining/fee-intel'].get
$.paths['/v1/mining/next-block-advice'].get
$.paths['/v1/mining/economics'].get
$.paths['/v1/mining/payout'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Thehiveryiq Com Mining API
version: 1.0.0
extends: openapi/thehiveryiq-com-mining-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 8
- target: $.paths['/v1/mining/scan'].get
update:
x-apievangelist-phrasing:
intent: Scan mining workers and hashrate offers
effect: read
questions:
- Which mining workers and hashrate auction offers are available right now?
- Is there a free way to see the MDK workers before booking hashrate?
instructions:
- text: Scan the available mining workers and auction offers.
- text: List MDK workers and hashrate offers.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/mining/route'].post
update:
x-apievangelist-phrasing:
intent: Rank mining destinations for a fleet
effect: read
questions:
- Where should my mining fleet point its hashrate given my energy cost?
- Can I rank mining destinations for a region without paying a routing fee?
instructions:
- text: Rank destinations for a {fleet_size_th_s} TH/s fleet paying {energy_cost_usdc_per_kwh} USDC per kWh.
slots:
fleet_size_th_s: requestBody.fleet_size_th_s
energy_cost_usdc_per_kwh: requestBody.energy_cost_usdc_per_kwh
- text: Route a {fleet_size_th_s} TH/s fleet in {region} at {energy_cost_usdc_per_kwh} USDC/kWh.
slots:
fleet_size_th_s: requestBody.fleet_size_th_s
region: requestBody.region
energy_cost_usdc_per_kwh: requestBody.energy_cost_usdc_per_kwh
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/mining/book'].post
update:
x-apievangelist-phrasing:
intent: Book hashrate from a mining worker
effect: write
questions:
- How do I book hashrate from a worker for a set number of minutes?
- What fee and receipt do I get when I book mining hashrate?
instructions:
- text: Book {hashrate_th_s} TH/s from worker {worker_id} for {duration_minutes} minutes, paid by {payer_address}.
slots:
hashrate_th_s: requestBody.hashrate_th_s
worker_id: requestBody.worker_id
duration_minutes: requestBody.duration_minutes
payer_address: requestBody.payer_address
- text: Book worker {worker_id} at {hashrate_th_s} TH/s for {duration_minutes} minutes from {payer_address}, settling in {settle_asset}.
slots:
worker_id: requestBody.worker_id
hashrate_th_s: requestBody.hashrate_th_s
duration_minutes: requestBody.duration_minutes
payer_address: requestBody.payer_address
settle_asset: requestBody.settle_asset
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/mining/pnl'].get
update:
x-apievangelist-phrasing:
intent: View mining profit and loss
effect: read
questions:
- What is the profit and loss on mining so far?
- Is the hashrate routing business making or losing money?
instructions:
- text: Show the mining P&L.
- text: Report mining profit and loss.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/mining/fee-intel'].get
update:
x-apievangelist-phrasing:
intent: Get Bitcoin fee intelligence
effect: read
questions:
- What does the current Bitcoin fee landscape look like alongside next-block fees?
- Is there a paid feed combining fee landscape and next-block data?
instructions:
- text: Get the mining fee intel report.
- text: Show combined fee landscape and next-block fee data.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/mining/next-block-advice'].get
update:
x-apievangelist-phrasing:
intent: Get next-block fee advice
effect: read
questions:
- What fee should I target to land in the next Bitcoin block?
- Can I get next-block advice that factors in the hashrate auction state?
instructions:
- text: Get next-block advice.
- text: Advise me on fees for the next block using the auction state.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/mining/economics'].get
update:
x-apievangelist-phrasing:
intent: View daily mining revenue and spend
effect: read
questions:
- What is the daily mining revenue and how much was spent on fee data?
- Where can I monitor the mining desk's economics?
instructions:
- text: Show mining economics for today.
- text: Report daily mining revenue and data spend.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/mining/payout'].post
update:
x-apievangelist-phrasing:
intent: Swap mined BTC to USDC on Base
effect: write
questions:
- How do I convert mined bitcoin into USDC on Base?
- What spread is charged when paying out BTC as USDC?
instructions:
- text: Pay out {btc_amount_sats} sats as USDC to {recipient_usdc_address}.
slots:
btc_amount_sats: requestBody.btc_amount_sats
recipient_usdc_address: requestBody.recipient_usdc_address
- text: Swap {btc_amount_sats} satoshis to USDC on Base and send to {recipient_usdc_address}.
slots:
btc_amount_sats: requestBody.btc_amount_sats
recipient_usdc_address: requestBody.recipient_usdc_address
method: generated
generated: '2026-09-26'