> ## Documentation Index
> Fetch the complete documentation index at: https://perps-api.vooi.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Price spread candles for a market pair

> Returns all stored price spread candles for a market pair at the requested resolution, oldest first. Leg A is the buy (ask) side and leg B is the sell (bid) side; the spread is computed as `2 * (bidB - askA) / (bidB + askA)`. Intervals without ticks are omitted, not zero-filled.



## OpenAPI

````yaml https://vooi-api-app.fly.dev/swagger/json get /arbitrage-scanner/price-spread-candles
openapi: 3.1.0
info:
  title: VOOI API
  description: Unified perps API
  version: '1.0'
  contact: {}
servers:
  - url: https://perps-api.vooi.io
security: []
tags: []
paths:
  /arbitrage-scanner/price-spread-candles:
    get:
      tags:
        - Arbitrage Scanner
      summary: Price spread candles for a market pair
      description: >-
        Returns all stored price spread candles for a market pair at the
        requested resolution, oldest first. Leg A is the buy (ask) side and leg
        B is the sell (bid) side; the spread is computed as `2 * (bidB - askA) /
        (bidB + askA)`. Intervals without ticks are omitted, not zero-filled.
      operationId: ArbitrageScannerController_getPriceSpreadCandles
      parameters:
        - name: assetA
          required: true
          in: query
          schema:
            type: string
            minLength: 1
            example: BTC
          description: Asset identifier of the first leg market.
        - name: assetB
          required: true
          in: query
          schema:
            type: string
            minLength: 1
            example: BTC
          description: Asset identifier of the second leg market.
        - name: exchangeA
          required: true
          in: query
          schema:
            type: string
            enum:
              - aster
              - binance
              - bybit
              - extended
              - gate
              - hyperliquid
              - lighter
              - mexc
              - ondo
              - robinhood
            example: lighter
          description: Exchange of the first leg market.
        - name: exchangeB
          required: true
          in: query
          schema:
            type: string
            enum:
              - aster
              - binance
              - bybit
              - extended
              - gate
              - hyperliquid
              - lighter
              - mexc
              - ondo
              - robinhood
            example: aster
          description: Exchange of the second leg market.
        - name: resolution
          required: true
          in: query
          schema:
            type: string
            enum:
              - 1m
              - 5m
              - 15m
              - 30m
              - 1h
              - 4h
              - 12h
              - 1d
            example: 1m
          description: Candle resolution
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPriceSpreadCandlesResponseDto'
components:
  schemas:
    GetPriceSpreadCandlesResponseDto:
      type: array
      items:
        $ref: '#/components/schemas/PriceSpreadCandleDto'
      title: GetPriceSpreadCandlesResponse
    PriceSpreadCandleDto:
      type: object
      properties:
        close:
          type: string
          description: Price spread at the end of the interval, as a decimal fraction.
          example: '0.0000128'
        high:
          type: string
          description: Maximum price spread of the interval, as a decimal fraction.
          example: '0.0000128'
        low:
          type: string
          description: Minimum price spread of the interval, as a decimal fraction.
          example: '0.0000128'
        open:
          type: string
          description: Price spread at the start of the interval, as a decimal fraction.
          example: '0.0000128'
        timestamp:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Start of the interval as a unix timestamp in milliseconds.
          example: 1784715300000
      required:
        - close
        - high
        - low
        - open
        - timestamp
      title: PriceSpreadCandle

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.