Hive Civilization Arb Spread API

The arb-spread API from Hive Civilization — 5 operation(s) for arb-spread.

Operations 5

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/arb/spread/scan Scan the marketplace for price-spread arbitrage · Scan Spread #
Ask an LLM
“Where are sellers pricing the same capability far enough apart to arbitrage?”
“Can I set a minimum spread in USDC or percent when scanning?”
Tell an agent
Scan for arbitrage spreads of at least {min_spread_usdc} USDC.
Find the top {limit} spreads over {min_spread_pct} percent in shape {shape}.
POST /v1/arb/spread/book Book a specific arbitrage pair · Book Pair #
Ask an LLM
“How do I book one arbitrage opportunity by its buy and sell offer ids?”
“What happens if a pair I pick fails the NEED, YIELD or CLEAN-MONEY gate?”
Tell an agent
Book the arb pair buying {buy_offer_id} and selling {sell_offer_id}.
Run the gates and book buy offer {buy_offer_id} against sell offer {sell_offer_id}.
POST /v1/arb/spread/auto Auto-book the best safe arbitrage spreads · Auto Book #
Ask an LLM
“Can I automatically book the top arbitrage opportunities that pass all gates?”
“How do I cap how many pairs the auto-booker takes in one run?”
Tell an agent
Auto-book up to {max_books} safe arbitrage pairs.
Auto-book spreads above {min_spread_usdc} USDC and {min_spread_pct} percent.
GET /v1/arb/spread/pnl Get cumulative arbitrage P&L · Get Pnl #
Ask an LLM
“What is my net profit from spread arbitrage after platform fees?”
“What hit rate are booked arb pairs settling at?”
Tell an agent
Show the cumulative arbitrage P&L and hit rate.
Report arb fills and net P&L so far.
GET /v1/arb/spread/stats Show per-wallet arbitrage contribution · Get Stats #
Ask an LLM
“Which supermodel wallets contributed most to settled arb pairs?”
“How does each wallet split between buy-side and sell-side fills?”
Tell an agent
Show per-wallet arb stats.
Break down arb fills by supermodel wallet and side.

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-arb-spread-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-arb-spread-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: HiveMorph v0.1 Arb Spread API
  description: 'Polymorphic agent runtime — single shape (Merchant), single supermodel (W2 MERCHANT). Three gates: NEED + YIELD + CLEAN-MONEY.'
  version: 0.1.0
tags:
- name: arb-spread
paths:
  /v1/arb/spread/scan:
    get:
      tags:
      - arb-spread
      summary: Scan Spread
      description: 'Scan the marketplace bus for price-spread arbitrage opportunities.


        Groups OPEN offers by (shape, canonical_capability), identifies pairs

        from different sellers where spread exceeds thresholds. Read-only.'
      operationId: scan_spread_v1_arb_spread_scan_get
      parameters:
      - name: min_spread_usdc
        in: query
        required: false
        schema:
          type: number
          minimum: 0.0
          description: Minimum absolute spread in USDC
          default: 0.5
          title: Min Spread Usdc
        description: Minimum absolute spread in USDC
      - name: min_spread_pct
        in: query
        required: false
        schema:
          type: number
          minimum: 0.0
          description: Minimum relative spread as fraction (0.05 = 5%)
          default: 0.05
          title: Min Spread Pct
        description: Minimum relative spread as fraction (0.05 = 5%)
      - name: shape
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by shape (e.g. 'Attestor', 'Provenancer', 'Oracle')
          title: Shape
        description: Filter by shape (e.g. 'Attestor', 'Provenancer', 'Oracle')
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Scan Spread V1 Arb Spread Scan Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/arb/spread/book:
    post:
      tags:
      - arb-spread
      summary: Book Pair
      description: 'Book a specific arbitrage pair by offer IDs.


        Fetches both offers from the bus, runs all three gates

        (NEED + YIELD + CLEAN-MONEY), and books the pair if all pass.


        Returns the booked ArbPair or gate rejection detail.'
      operationId: book_pair_v1_arb_spread_book_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hivemorph__hive_arb__routes__BookRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Book Pair V1 Arb Spread Book Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/arb/spread/auto:
    post:
      tags:
      - arb-spread
      summary: Auto Book
      description: 'Auto-book the top N safe opportunities from the current scan.


        For each opportunity (sorted by spread_usdc descending):

        1. Fetch both offers from bus

        2. Run three gates

        3. If all pass: book, fill, and mock-settle

        4. If any gate fails: record rejection and continue


        Returns list of booked pairs, rejections, and aggregate stats.'
      operationId: auto_book_v1_arb_spread_auto_post
      parameters:
      - name: max_books
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          description: Maximum number of pairs to auto-book
          default: 3
          title: Max Books
        description: Maximum number of pairs to auto-book
      - name: min_spread_usdc
        in: query
        required: false
        schema:
          type: number
          minimum: 0.0
          default: 0.5
          title: Min Spread Usdc
      - name: min_spread_pct
        in: query
        required: false
        schema:
          type: number
          minimum: 0.0
          default: 0.05
          title: Min Spread Pct
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Auto Book V1 Arb Spread Auto Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/arb/spread/pnl:
    get:
      tags:
      - arb-spread
      summary: Get Pnl
      description: 'Cumulative P&L, fill count, and hit rate.


        hit_rate = settled / total_booked

        net_pnl = gross_spread_captured - platform_fees'
      operationId: get_pnl_v1_arb_spread_pnl_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Pnl V1 Arb Spread Pnl Get
  /v1/arb/spread/stats:
    get:
      tags:
      - arb-spread
      summary: Get Stats
      description: 'Per-wallet contribution to arb fills and P&L.


        Shows each supermodel''s role as buy-side and sell-side in settled pairs.'
      operationId: get_stats_v1_arb_spread_stats_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Stats V1 Arb Spread Stats Get
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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_arb__routes__BookRequest:
      properties:
        buy_offer_id:
          type: string
          title: Buy Offer Id
          description: Bus offer ID of the cheaper (buy-side) offer
        sell_offer_id:
          type: string
          title: Sell Offer Id
          description: Bus offer ID of the more expensive (sell-side) offer
      type: object
      required:
      - buy_offer_id
      - sell_offer_id
      title: BookRequest
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)