Hive Civilization Mining Orchestrate API

The mining-orchestrate API from Hive Civilization — 6 operation(s) for mining-orchestrate.

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/mining/orchestrate/health Check the mining orchestration layer · Orchestrate Health #
Ask an LLM
“What capabilities and version does the MOS orchestration layer report?”
“Is the mining orchestration service healthy?”
Tell an agent
Check mining orchestration health.
Show the MOS orchestration layer's capabilities and version.
POST /v1/mining/orchestrate/register Register a mining operator's MOS instance · Orchestrate Register #
Ask an LLM
“How do I register my MOS instance as a mining operator?”
“Can I re-register my operator to update the endpoint or sites?”
Tell an agent
Register operator {operator_did} with MOS endpoint {mos_endpoint} and wallet {wallet_addr}.
Register MOS operator {operator_did} at {mos_endpoint} paying to {wallet_addr} with sites {sites}.
POST /v1/mining/orchestrate/sites/sync Push a site telemetry batch · Orchestrate Sites Sync #
Ask an LLM
“How does an operator push worker telemetry for a mining site?”
“Is it safe to resend the same telemetry batch twice?”
Tell an agent
Sync site {site_id} for operator {operator_did} with batch timestamp {batch_ts}.
Push telemetry {telemetry} for site {site_id} from {operator_did} at {batch_ts}.
GET /v1/mining/orchestrate/sites List an operator's mining sites · Orchestrate Sites #
Ask an LLM
“Which sites has a mining operator registered and what is their latest telemetry?”
“Where can I see my mining sites' most recent readings?”
Tell an agent
List the sites for operator {operator_did}.
Show latest site telemetry for {operator_did}.
GET /v1/mining/orchestrate/payouts Get an operator's pending USDC payout · Orchestrate Payouts #
Ask an LLM
“How much USDC is waiting to be paid out to a mining operator?”
“What is my pending payout balance on the earn rails ledger?”
Tell an agent
Show pending payouts for operator {operator_did}.
Get the USDC payout balance owed to {operator_did}.
POST /v1/mining/orchestrate/payouts/withdraw Withdraw an operator's mining payout · Orchestrate Payouts Withdraw #
Ask an LLM
“How does a mining operator withdraw their pending USDC balance?”
“Is a payout withdrawal broadcast right away or only constructed?”
Tell an agent
Withdraw {amount_usdc} USDC for operator {operator_did}.
Construct a {amount_usdc} USDC payout withdrawal for {operator_did}.

Documentation

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/thehiveryiq-com:thehiveryiq-com-mining-orchestrate-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

thehiveryiq-com-mining-orchestrate-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: HiveMorph v0.1 Mining Orchestrate API
  description: 'Polymorphic agent runtime — single shape (Merchant), single supermodel (W2 MERCHANT). Three gates: NEED + YIELD + CLEAN-MONEY.'
  version: 0.1.0
tags:
- name: mining-orchestrate
paths:
  /v1/mining/orchestrate/health:
    get:
      tags:
      - mining-orchestrate
      summary: Orchestrate Health
      description: Tier 0 — free. Capabilities & version of the MOS orchestration layer.
      operationId: orchestrate_health_v1_mining_orchestrate_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/mining/orchestrate/register:
    post:
      tags:
      - mining-orchestrate
      summary: Orchestrate Register
      description: 'Tier 3 $0.05 — operator registers their MOS instance.


        Idempotent on operator_did. Upserts on re-registration.

        Three gates:

        NEED: Valid operator_did + EVM wallet_addr + reachable mos_endpoint scheme.

        YIELD: Registration creates earning potential (immediately on /sites/sync).

        CLEAN-MONEY: wallet_addr must pass EVM checksum.'
      operationId: orchestrate_register_v1_mining_orchestrate_register_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hivemorph__hive_mining__orchestrate__RegisterRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mining/orchestrate/sites/sync:
    post:
      tags:
      - mining-orchestrate
      summary: Orchestrate Sites Sync
      description: 'Tier 3 $0.05 — operator pushes site/worker telemetry batch.


        Idempotent on (operator_did, site_id, batch_ts). Re-posting the same

        batch returns {"idempotent": True} without error.'
      operationId: orchestrate_sites_sync_v1_mining_orchestrate_sites_sync_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteSyncRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mining/orchestrate/sites:
    get:
      tags:
      - mining-orchestrate
      summary: Orchestrate Sites
      description: Tier 1 $0.001 — list operator's registered sites and latest telemetry.
      operationId: orchestrate_sites_v1_mining_orchestrate_sites_get
      parameters:
      - name: operator_did
        in: query
        required: true
        schema:
          type: string
          title: Operator Did
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mining/orchestrate/payouts:
    get:
      tags:
      - mining-orchestrate
      summary: Orchestrate Payouts
      description: Tier 1 $0.001 — operator's pending USDC payout balance from earn rails ledger.
      operationId: orchestrate_payouts_v1_mining_orchestrate_payouts_get
      parameters:
      - name: operator_did
        in: query
        required: true
        schema:
          type: string
          title: Operator Did
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/mining/orchestrate/payouts/withdraw:
    post:
      tags:
      - mining-orchestrate
      summary: Orchestrate Payouts Withdraw
      description: 'Tier 3 $0.05 — construct BTC→USDC payout via Boltz + earn rails sweep.


        Constructed-only by default (EARN_SWEEP_AUTODISPATCH=false per Rule 9).

        Set EARN_SWEEP_AUTODISPATCH=true to enable real Boltz broadcast.'
      operationId: orchestrate_payouts_withdraw_v1_mining_orchestrate_payouts_withdraw_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WithdrawRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WithdrawRequest:
      properties:
        operator_did:
          type: string
          maxLength: 256
          minLength: 3
          title: Operator Did
        amount_usdc:
          type: number
          maximum: 100000.0
          exclusiveMinimum: 0.0
          title: Amount Usdc
      type: object
      required:
      - operator_did
      - amount_usdc
      title: WithdrawRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    hivemorph__hive_mining__orchestrate__RegisterRequest:
      properties:
        operator_did:
          type: string
          maxLength: 256
          minLength: 3
          title: Operator Did
        mos_endpoint:
          type: string
          minLength: 7
          title: Mos Endpoint
        sites:
          items:
            type: string
          type: array
          title: Sites
        wallet_addr:
          type: string
          title: Wallet Addr
      type: object
      required:
      - operator_did
      - mos_endpoint
      - wallet_addr
      title: RegisterRequest
    SiteSyncRequest:
      properties:
        operator_did:
          type: string
          maxLength: 256
          minLength: 3
          title: Operator Did
        site_id:
          type: string
          maxLength: 128
          minLength: 1
          title: Site Id
        batch_ts:
          type: integer
          exclusiveMinimum: 0.0
          title: Batch Ts
        telemetry:
          additionalProperties: true
          type: object
          title: Telemetry
      type: object
      required:
      - operator_did
      - site_id
      - batch_ts
      title: SiteSyncRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
x-provenance:
  method: harvested
  publisher: Hive Civilization
  source: https://receipts.thehiveryiq.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)