Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 3.7 KB

File metadata and controls

85 lines (58 loc) · 3.7 KB

MOBULA_STATE

1.3.2 v3

This document was generated automatically. Please see README Generator for more info.

Environment Variables

Required? Name Description Type Options Default
WS_API_ENDPOINT WS endpoint for Data Provider string wss://production-feed.mobula.io
WS_FUNDING_RATE_API_ENDPOINT WS endpoint for perpetual funding rates string wss://api.mobula.io
API_KEY An API key for Data Provider string

Data Provider Rate Limits

There are no rate limits for this adapter.


Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string crypto, funding-rate, price, state price

Price Endpoint

Supported names for this endpoint are: crypto, price, state.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
base coin, from, market, symbol The symbol of symbols of the currency to query string
quote convert, to The symbol of the currency to convert to string

Example

Request:

{
  "data": {
    "endpoint": "price",
    "base": "ETH",
    "quote": "USD"
  }
}

Funding-rate Endpoint

funding-rate is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
base coin, from, market, symbol The symbol of symbols of the currency to query string
quote convert, to The symbol of the currency to convert to string
exchange Which exchange to return the funding rate for string

Example

Request:

{
  "data": {
    "endpoint": "funding-rate",
    "base": "BTC",
    "quote": "USDC",
    "exchange": "binance"
  }
}

MIT License