Tapehall Alerts API
Alert management (create, list). Requires tier ≥1.
Alert management (create, list). Requires tier ≥1.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mrtrades-com:mrtrades-com-alerts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Tapehall Alerts 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: Alerts
description: Alert management (create, list). Requires tier ≥1.
paths:
/v1/alerts:
post:
tags:
- Alerts
summary: Create Alert
operationId: create_alert_v1_alerts_post
parameters:
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AlertCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Create Alert V1 Alerts Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Alerts
summary: List Alerts
operationId: list_alerts_v1_alerts_get
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response List Alerts V1 Alerts Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/keys:
post:
tags:
- Alerts
summary: Create Inbound Key
operationId: create_inbound_key_v1_alerts_inbound_keys_post
parameters:
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookKeyCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Create Inbound Key V1 Alerts Inbound Keys Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Alerts
summary: List Inbound Keys
operationId: list_inbound_keys_v1_alerts_inbound_keys_get
parameters:
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response List Inbound Keys V1 Alerts Inbound Keys Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/keys/{key_id}:
put:
tags:
- Alerts
summary: Update Inbound Key Label
description: Rename a webhook key (label only). Token is immutable.
operationId: update_inbound_key_label_v1_alerts_inbound_keys__key_id__put
parameters:
- name: key_id
in: path
required: true
schema:
type: integer
title: Key Id
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookKeyLabelUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Update Inbound Key Label V1 Alerts Inbound Keys Key Id Put
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/keys/{key_id}/retention:
put:
tags:
- Alerts
summary: Update Inbound Key Retention
description: 7, 30 or 90 days, or null = forever. Older alerts move to the archive nightly.
operationId: update_inbound_key_retention_v1_alerts_inbound_keys__key_id__retention_put
parameters:
- name: key_id
in: path
required: true
schema:
type: integer
title: Key Id
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookKeyRetentionUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Update Inbound Key Retention V1 Alerts Inbound Keys Key Id Retention Put
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/keys/{key_id}/enable-signing:
post:
tags:
- Alerts
summary: Enable Inbound Key Signing
description: Turn on HMAC signing for an existing key; returns a new signing secret once.
operationId: enable_inbound_key_signing_v1_alerts_inbound_keys__key_id__enable_signing_post
parameters:
- name: key_id
in: path
required: true
schema:
type: integer
title: Key Id
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Enable Inbound Key Signing V1 Alerts Inbound Keys Key Id Enable Signing Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/keys/{key_id}/revoke:
post:
tags:
- Alerts
summary: Revoke Inbound Key
operationId: revoke_inbound_key_v1_alerts_inbound_keys__key_id__revoke_post
parameters:
- name: key_id
in: path
required: true
schema:
type: integer
title: Key Id
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Revoke Inbound Key V1 Alerts Inbound Keys Key Id Revoke Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/events:
get:
tags:
- Alerts
summary: List Inbound Events
description: 'Newest first. With no paging params the response is the pre-0.4.254 shape
(``{"events": [...]}``, newest ``limit``). Any of cursor/since/until/key_id/
ticker/archived adds ``next_cursor`` (null on the last page).'
operationId: list_inbound_events_v1_alerts_inbound_events_get
parameters:
- name: limit
in: query
required: false
schema:
type: integer
maximum: 500
minimum: 1
default: 100
title: Limit
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
- name: since
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Since
- name: until
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Until
- name: key_id
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Key Id
- name: ticker
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Ticker
- name: archived
in: query
required: false
schema:
type: boolean
default: false
title: Archived
- name: paged
in: query
required: false
schema:
type: boolean
default: false
title: Paged
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response List Inbound Events V1 Alerts Inbound Events Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Alerts
summary: Clear Inbound Events
description: 'Soft delete: rows move to the archive (reason ``user_clear``), never dropped.
With ``key_id`` only that webhook''s alerts are cleared. Clearing everything
needs ``confirm``: call once without it to get ``confirm_token`` and the
count (HTTP 409), then repeat with ``?confirm=``. A new alert in
between makes the token stale (409 again).'
operationId: clear_inbound_events_v1_alerts_inbound_events_delete
parameters:
- name: key_id
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Key Id
- name: confirm
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Confirm
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Clear Inbound Events V1 Alerts Inbound Events Delete
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/events/export:
get:
tags:
- Alerts
summary: Export Inbound Events
description: CSV of inbound alerts, newest first, same filters as the list. Streamed in pages.
operationId: export_inbound_events_v1_alerts_inbound_events_export_get
parameters:
- name: since
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Since
- name: until
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Until
- name: key_id
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Key Id
- name: ticker
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Ticker
- name: archived
in: query
required: false
schema:
type: boolean
default: false
title: Archived
- name: max_rows
in: query
required: false
schema:
type: integer
maximum: 1000000
minimum: 1
default: 100000
title: Max Rows
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound:
post:
tags:
- Alerts
summary: Receive Inbound Alert No Path Token
operationId: receive_inbound_alert_no_path_token_v1_alerts_inbound_post
parameters:
- name: token
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Token
- name: x-webhook-token
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Webhook-Token
- name: x-mrtrades-timestamp
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Timestamp
- name: x-mrtrades-signature
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Signature
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Receive Inbound Alert No Path Token V1 Alerts Inbound Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/alerts/inbound/{token}:
head:
tags:
- Alerts
summary: Receive Inbound Alert
operationId: receive_inbound_alert_v1_alerts_inbound__token__head
parameters:
- name: token
in: path
required: true
schema:
type: string
title: Token
- name: x-mrtrades-timestamp
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Timestamp
- name: x-mrtrades-signature
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Signature
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Alerts
summary: Receive Inbound Alert
operationId: getV1AlertsInboundByToken
parameters:
- name: token
in: path
required: true
schema:
type: string
title: Token
- name: x-mrtrades-timestamp
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Timestamp
- name: x-mrtrades-signature
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Signature
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-operation-id-source: normalized
x-operation-id-original: receive_inbound_alert_v1_alerts_inbound__token__head
post:
tags:
- Alerts
summary: Receive Inbound Alert
operationId: postV1AlertsInboundByToken
parameters:
- name: token
in: path
required: true
schema:
type: string
title: Token
- name: x-mrtrades-timestamp
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Timestamp
- name: x-mrtrades-signature
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Mrtrades-Signature
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-operation-id-source: normalized
x-operation-id-original: receive_inbound_alert_v1_alerts_inbound__token__head
components:
schemas:
WebhookKeyLabelUpdate:
properties:
label:
anyOf:
- type: string
- type: 'null'
title: Label
type: object
title: WebhookKeyLabelUpdate
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
WebhookKeyCreate:
properties:
label:
anyOf:
- type: string
- type: 'null'
title: Label
source:
anyOf:
- type: string
- type: 'null'
title: Source
require_signature:
type: boolean
title: Require Signature
default: false
type: object
title: WebhookKeyCreate
WebhookKeyRetentionUpdate:
properties:
retention_days:
anyOf:
- type: integer
- type: 'null'
title: Retention Days
type: object
title: WebhookKeyRetentionUpdate
AlertCreate:
properties:
symbol:
type: string
title: Symbol
thesis:
type: string
title: Thesis
threshold:
type: integer
title: Threshold
default: 70
callback_url:
type: string
maxLength: 2083
minLength: 1
format: uri
title: Callback Url
type: object
required:
- symbol
- thesis
- callback_url
title: AlertCreate
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