Aevo

AevoClient <: AbstractAPIsClient

Client info.

Required fields

• base_url::String: Base URL for the client.

Optional fields

• public_key::String: Public key for authentication.
• secret_key::String: Secret key for authentication.
• interface::String: Interface for the client.
• proxy::String: Proxy information for the client.
• account_name::String: Account name associated with the client.
• description::String: Description of the client.

AevoAPIError{T} <: AbstractAPIsError

Exception thrown when an API method fails with code T.

Required fields

• error::String: Error message.

public_client = AevoClient(; base_url = "https://api.aevo.xyz")

funding_rate(client::AevoClient, query::FundingRateQuery)
funding_rate(client::AevoClient = Aevo.Futures.public_client; kw...)

Returns the funding rate history for the instrument.

GET funding-history

Code samples:

using Serde
using CryptoExchangeAPIs.Aevo

result = Aevo.Futures.funding_rate(; 
    instrument_name = "ETH-PERP",
)

to_pretty_json(result.result)

Result:

{
  "funding_history":[
    {
      "instrument_name":"ETH-PERP",
      "timestamp":"2024-07-08T22:00:00",
      "funding_rate":2.0e-6,
      "mark_price":3026.093939
    },
    ...
  ]
}

product_stats(client::AevoClient, query::ProductStatsQuery)
product_stats(client::AevoClient = Aevo.Futures.public_client; kw...)

Returns the market statistics for the given asset.

GET statistics

Code samples:

using Serde
using CryptoExchangeAPIs.Aevo

result = Aevo.Futures.product_stats(; 
    asset = "ETH",
    instrument_type = Aevo.Futures.ProductStats.PERPETUAL,
)

to_pretty_json(result.result)

Result:

{
  "asset":"ETH",
  "open_interest":{
    "total":2678.156722
  },
  "daily_volume":2.0555100110632844e7,
  "daily_buy_volume":9.661439151821265e6,
  "daily_sell_volume":1.0893660958811581e7,
  "daily_volume_premium":null,
  "total_volume":17795.39194288,
  "total_volume_premium":null,
  "daily_volume_contracts":6942.52,
  "index_price":2973.386837,
  "index_daily_change":14.858767,
  "mark_price":2972.9028,
  "mark_price_24h_ago":2964.452868,
  "mark_daily_change":8.449932,
  "funding_daily_avg":-4.0e-6,
  "put_call_ratio":null
}