# Bid Ask
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/bidAsk:
get:
summary: Bid Ask
deprecated: false
description: >-
A bid (or limit buy) is a “passive” buyer who advertises the price and
size they would like to buy at. An asks (or limit sell) is a “passive”
seller who advertises the price and size they would like to sell at.
tags:
- Orderbook
- Orderbook
parameters:
- name: coin
in: query
description: >-
Please enter the valid coin. All the supported coins with their
respective exchanges can be fetched via /catalog endpoint.
required: true
example: BTC
schema:
type: string
- name: exchange
in: query
description: >-
Please enter the valid exchange, you can enter single or multiple
exchange with comma separated. All the supported exchanges with
their respective coins can be fetched via /catalog endpoint.
required: false
example: binance_perp_stable
schema:
type: string
default: >-
binance_perp_coin, binance_perp_stable, binance_spot,
bitfinex_perp_stable, bitget_perp_coin, bitget_perp_stable,
bitget_spot, bitmex_perp_coin, bybit_perp_coin, bybit_perp_stable,
bybit_spot, coinbase_spot, coinbaseadvanced_perp_stable,
deribit_perp_stable, huobi_perp_coin, hyperliquid_perp_stable,
hyperliquid_spot, hyperliquid_xyz, lighter_perp_stable,
lighter_spot, okx_perp_coin, okx_perp_stable, okx_qtrly, okx_spot
- name: timeframe
in: query
description: >-
Please enter the valid timeframe:
`1m`: `1 minute`
`5m`: `5
minutes`
`15m`: `15 minutes`
`1h`: `1 hour`
`4h`: `4
hours`
`1d`: `1 day`
required: true
example: 1m
schema:
type: string
- name: limit
in: query
description: >-
Please enter the limit size. Values: 5, 10, 20, 50, 100, 500, 1000
Default: 50
required: false
example: '50'
schema:
type: string
- name: startTime
in: query
description: >-
Please enter the valid startTime. If you do not enter any startTime,
the default will be current time (e.g. 1782777600).
required: false
example: '1782777600'
schema:
type: string
- name: endTime
in: query
description: >-
Please enter the valid endTime. If you do not enter any endTime, the
default will be current time (e.g. 1782864000).
required: false
example: '1782864000'
schema:
type: string
- name: sort
in: query
description: >-
If `desc`, will sort results newest first.
`asc`: `ascending
order`
`desc`: `descending order`
Default: asc
required: false
example: asc
schema:
type: string
- name: advanceFilter
in: query
description: >-
Enter an advanced filter option.
`normalize` Scales the series
to a 0–100 range per selection..
`anchor_1h` Computes anchored
indicators with a 1-hour anchor window.
`anchor_4h` Computes
anchored indicators with a 4-hour anchor window.
`anchor_1d`
Computes anchored indicators with a 1-day anchor window.
default:`none`, no advanced filter is applied and operations are
performed directly on raw market values.
Default: none
required: false
example: none
schema:
type: string
- name: marketTypes
in: query
description: >-
Please enter the valid marketTypes : all, spot, perpetuals
Default: all
required: false
example: all
schema:
type: string
- name: depth
in: query
description: >-
You can enter one or two depth values separated by a comma to define
a range. Behavior:
A single value means a range from 0–X%.
Example: 1 → 0–1%
Two values mean a range from start–end%.
Example: 1,5 → 1–5% (skips 0–1%)
More than two values are not
allowed.
`quote`: `quoteLevel`
`1`: `depth1`
`2`:
`depth2`
`5`: `depth5`
`10`: `depth10`
`20`:
`depth20`
`full`: `fullbook`
Available values: quote, 1,
2, 5, 10, 20, full
Default: 0,5
required: false
example: 0,5
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BidAskResponse'
headers: {}
x-apidog-name: OK
'400':
description: Bad Request
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apidog-name: Bad Request
'422':
description: Unprocessable Entity
content:
application/json:
schema: *ref_0
headers: {}
x-apidog-name: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema: *ref_0
headers: {}
x-apidog-name: Forbidden
security:
- ApiKeyAuth: []
x-apidog:
schemeGroups:
- id: XZH8riJm2eD6Qj2R5tmV6
schemeIds:
- ApiKeyAuth
required: true
use:
id: XZH8riJm2eD6Qj2R5tmV6
scopes:
XZH8riJm2eD6Qj2R5tmV6:
ApiKeyAuth: []
x-apidog-folder: Orderbook
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1156882/apis/api-25773553-run
components:
schemas:
BidAskResponse:
properties:
data:
items:
properties:
ask:
type: number
examples:
- 223478946.93349946
bid:
type: number
examples:
- 137103871.66530034
openDate:
type: integer
examples:
- 1783687080
type: object
x-apidog-orders:
- ask
- bid
- openDate
x-apidog-ignore-properties: []
type: array
metadata:
properties:
exchanges:
items:
type: string
type: array
examples:
- - binance_perp_stable
unsupportedExchanges:
items:
type: string
type: array
examples:
- - okx_perp_stable
type: object
x-apidog-orders:
- exchanges
- unsupportedExchanges
x-apidog-ignore-properties: []
type: object
x-apidog-orders:
- data
- metadata
x-apidog-ignore-properties: []
x-apidog-folder: ''
ErrorResponse:
properties:
detail:
properties:
error_code:
type: string
message:
type: string
type: object
x-apidog-orders:
- error_code
- message
x-apidog-ignore-properties: []
type: object
x-apidog-orders:
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
ApiKeyAuth:
type: apikey
in: header
name: x-api-key
servers:
- url: https://api.hyblockcapital.com/v2
description: Hyblock Capital
security:
- ApiKeyAuth: []
x-apidog:
schemeGroups:
- id: XZH8riJm2eD6Qj2R5tmV6
schemeIds:
- ApiKeyAuth
required: true
use:
id: XZH8riJm2eD6Qj2R5tmV6
scopes:
XZH8riJm2eD6Qj2R5tmV6:
ApiKeyAuth: []
```