Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Arb Spread API

6 actions 6 updates phrasing extends openapi/thehiveryiq-com-arb-spread-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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/arb/spread/scan'].get

$.paths['/v1/arb/spread/book'].post

$.paths['/v1/arb/spread/auto'].post

$.paths['/v1/arb/spread/pnl'].get

$.paths['/v1/arb/spread/stats'].get

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 Arb Spread API
  version: 1.0.0
extends: openapi/thehiveryiq-com-arb-spread-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: 5
- target: $.paths['/v1/arb/spread/scan'].get
  update:
    x-apievangelist-phrasing:
      intent: Scan the marketplace for price-spread arbitrage
      effect: read
      questions:
      - Where are sellers pricing the same capability far enough apart to arbitrage?
      - Can I set a minimum spread in USDC or percent when scanning?
      instructions:
      - text: Scan for arbitrage spreads of at least {min_spread_usdc} USDC.
        slots:
          min_spread_usdc: query.min_spread_usdc
      - text: Find the top {limit} spreads over {min_spread_pct} percent in shape {shape}.
        slots:
          limit: query.limit
          min_spread_pct: query.min_spread_pct
          shape: query.shape
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/arb/spread/book'].post
  update:
    x-apievangelist-phrasing:
      intent: Book a specific arbitrage pair
      effect: write
      questions:
      - 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?
      instructions:
      - text: Book the arb pair buying {buy_offer_id} and selling {sell_offer_id}.
        slots:
          buy_offer_id: requestBody.buy_offer_id
          sell_offer_id: requestBody.sell_offer_id
      - text: Run the gates and book buy offer {buy_offer_id} against sell offer {sell_offer_id}.
        slots:
          buy_offer_id: requestBody.buy_offer_id
          sell_offer_id: requestBody.sell_offer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/arb/spread/auto'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-book the best safe arbitrage spreads
      effect: write
      questions:
      - 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?
      instructions:
      - text: Auto-book up to {max_books} safe arbitrage pairs.
        slots:
          max_books: query.max_books
      - text: Auto-book spreads above {min_spread_usdc} USDC and {min_spread_pct} percent.
        slots:
          min_spread_usdc: query.min_spread_usdc
          min_spread_pct: query.min_spread_pct
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/arb/spread/pnl'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cumulative arbitrage P&L
      effect: read
      questions:
      - What is my net profit from spread arbitrage after platform fees?
      - What hit rate are booked arb pairs settling at?
      instructions:
      - text: Show the cumulative arbitrage P&L and hit rate.
      - text: Report arb fills and net P&L so far.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/arb/spread/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Show per-wallet arbitrage contribution
      effect: read
      questions:
      - Which supermodel wallets contributed most to settled arb pairs?
      - How does each wallet split between buy-side and sell-side fills?
      instructions:
      - text: Show per-wallet arb stats.
      - text: Break down arb fills by supermodel wallet and side.
      method: generated
      generated: '2026-09-26'