0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive HIP-3 Builder Perps - Candles API

2 actions 2 updates phrasing extends openapi/0xarchive-hip-3-builder-perps-candles-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for 0xArchive's API. It is a proposal applied on top of the contract, not a document 0xArchive publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/hyperliquid/hip3/candles/{symbol}'].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 0xArchive HIP-3 Builder Perps - Candles API
  version: 1.0.0
extends: openapi/0xarchive-hip-3-builder-perps-candles-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: 1
- target: $.paths['/v1/hyperliquid/hip3/candles/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get OHLCV candles for a HIP-3 builder perp
      effect: read
      questions:
      - Can I get hourly candles for a HIP-3 market like km:US500?
      - Which candle intervals do HIP-3 builder perps support?
      - Does candle coverage differ between HIP-3 symbols?
      instructions:
      - text: Get {interval} HIP-3 candles for {symbol} from {start} to {end}.
        slots:
          interval: query.interval
          symbol: path.symbol
          start: query.start
          end: query.end
      - text: Pull daily candles for builder perp {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'