Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Tapehall Scan API
description: 'Crypto-native perp screener and charting API.
**Auth**: Most endpoints accept `X-Api-Key` header. WebSocket endpoints use the `mtdp` subprotocol with API key.
Tier ≥1 required for live streams (scan, screener, chart candles, chart DOM).
**Rate limit**: per API key / session / IP sliding window (default 1200 cost units/min per key or session, 300/min per unauthenticated IP; heavy routes cost 10), max 16 concurrent requests per key. Over limit: 429 with Retry-After. Requests that have not started responding in 30s (90s heavy) get 504.'
version: 1.0.4
tags:
- name: Scan
description: Signal scanning (REST + WebSocket). Requires tier ≥1 for WebSocket.
paths:
/v1/scan/{symbol}:
get:
tags:
- Scan
summary: Scan Symbol
description: 'Signal scores (pump/dump/accumulation) for the symbol. Optional venue: when set, use only that venue''s data so signals match the chart.'
operationId: scan_symbol_v1_scan__symbol__get
parameters:
- name: symbol
in: path
required: true
schema:
type: string
title: Symbol
- name: venue
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Exchange (e.g. hyperliquid). When set, signals use only this venue so they match the chart.
title: Venue
description: Exchange (e.g. hyperliquid). When set, signals use only this venue so they match the chart.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Scan Symbol V1 Scan Symbol Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
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
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError