Perp Screener
Common Scenarios
Usecase
Required Parameters
Optional Filters
Expected Output
Authorizations
apiKeystringRequired
API key for authentication
Body
Request model for Perp Screener endpoint.
filtersany ofOptionalExample:
Additional filters to apply
{"token_symbol":"BTC","volume":{"min":10000}}order_byany ofOptionalExample:
Custom sort order to override the endpoint's default ordering.
Examples:
- [{"field": "volume", "direction": "DESC"}] - Sort by volume descending
- [{"field": "net_positionz_change", "direction": "DESC"}] - Sort by net_position_change descending
- [{"field": "buy_sell_pressure", "direction": "DESC"}] - Sort by buy/sell pressure descending (smart money)
Default behavior:
- When only_smart_money is False: sorts by buy_sell_pressure DESC
- When only_smart_money is True: sorts by net_position_change DESC
[{"direction":"DESC","field":"buy_sell_pressure"}]Responses
200
Perpetual contract screening data
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Unprocessable Content
application/json
429
Too Many Requests
application/json
500
Internal Server Error
application/json
post
/api/v1/perp-screenerLast updated
Was this helpful?