|
| 1 | +module Contracts |
| 2 | + |
| 3 | +export ContractsQuery, |
| 4 | + ContractsData, |
| 5 | + contracts |
| 6 | + |
| 7 | +using Serde |
| 8 | +using Dates, NanoDates, TimeZones |
| 9 | +using EnumX |
| 10 | + |
| 11 | +using CryptoExchangeAPIs.Bitget |
| 12 | +using CryptoExchangeAPIs.Bitget: Data |
| 13 | +using CryptoExchangeAPIs: Maybe, APIsRequest |
| 14 | + |
| 15 | +@enumx SettleType begin |
| 16 | + USDT_FUTURES |
| 17 | + USDC_FUTURES |
| 18 | + COIN_FUTURES |
| 19 | +end |
| 20 | + |
| 21 | +@enumx Status begin |
| 22 | + listed |
| 23 | + normal |
| 24 | + maintain |
| 25 | + limit_open |
| 26 | + restrictedAPI |
| 27 | + off |
| 28 | +end |
| 29 | + |
| 30 | +@enumx DeliveryPeriod this_quarter next_quarter |
| 31 | + |
| 32 | +@enumx ExpiryType perpetual delivery |
| 33 | + |
| 34 | +Base.@kwdef struct ContractsQuery <: BitgetPublicQuery |
| 35 | + symbol::Maybe{String} = nothing |
| 36 | + productType::SettleType.T |
| 37 | +end |
| 38 | + |
| 39 | +function Serde.SerQuery.ser_type(::Type{ContractsQuery}, x::SettleType.T) |
| 40 | + x == SettleType.USDT_FUTURES && return "USDT-FUTURES" |
| 41 | + x == SettleType.USDC_FUTURES && return "USDC-FUTURES" |
| 42 | + x == SettleType.COIN_FUTURES && return "COIN-FUTURES" |
| 43 | +end |
| 44 | + |
| 45 | +struct ContractsData <: BitgetData |
| 46 | + symbol::String |
| 47 | + baseCoin::String |
| 48 | + quoteCoin::String |
| 49 | + buyLimitPriceRatio::Float64 |
| 50 | + sellLimitPriceRatio::Float64 |
| 51 | + feeRateUpRatio::Float64 |
| 52 | + makerFeeRate::Float64 |
| 53 | + takerFeeRate::Float64 |
| 54 | + openCostUpRatio::Float64 |
| 55 | + supportMarginCoins::Vector{String} |
| 56 | + minTradeNum::Float64 |
| 57 | + priceEndStep::Float64 |
| 58 | + volumePlace::Int |
| 59 | + pricePlace::Int |
| 60 | + sizeMultiplier::Float64 |
| 61 | + symbolType::ExpiryType.T |
| 62 | + minTradeUSDT::Float64 |
| 63 | + maxSymbolOrderNum::Int |
| 64 | + maxProductOrderNum::Int |
| 65 | + maxPositionNum::Int |
| 66 | + symbolStatus::Status.T |
| 67 | + offTime::Maybe{NanoDate} |
| 68 | + limitOpenTime::Maybe{NanoDate} |
| 69 | + deliveryTime::Maybe{NanoDate} |
| 70 | + deliveryStartTime::Maybe{NanoDate} |
| 71 | + deliveryPeriod::Maybe{DeliveryPeriod.T} |
| 72 | + launchTime::Maybe{NanoDate} |
| 73 | + fundInterval::Maybe{Int} |
| 74 | + minLever::Int |
| 75 | + maxLever::Int |
| 76 | + posLimit::Maybe{Float64} |
| 77 | + maintainTime::Maybe{NanoDate} |
| 78 | + maxMarketOrderQty::Maybe{Float64} |
| 79 | + maxOrderQty::Maybe{Float64} |
| 80 | + isRwa::Bool |
| 81 | +end |
| 82 | + |
| 83 | +function Serde.deser(::Type{ContractsData}, ::Type{Bool}, s::String) |
| 84 | + uppercase(s) == "YES" && return true |
| 85 | + uppercase(s) == "NO" && return false |
| 86 | + throw(ArgumentError("invalid boolean string: $(s)")) |
| 87 | +end |
| 88 | + |
| 89 | +""" |
| 90 | + contracts(client::BitgetClient, query::ContractsQuery) |
| 91 | + contracts(client::BitgetClient = Bitget.BitgetClient(Bitget.public_config); kw...) |
| 92 | +
|
| 93 | +Interface is used to get future contract details. |
| 94 | +
|
| 95 | +[`GET api/v2/mix/market/contracts`](https://www.bitget.com/api-doc/contract/market/Get-All-Symbols-Contracts) |
| 96 | +
|
| 97 | +## Parameters: |
| 98 | +
|
| 99 | +| Parameter | Type | Required | Description | |
| 100 | +|:------------|:-----------|:---------|:---------------------------------------------| |
| 101 | +| symbol | String | false | | |
| 102 | +| productType | SettleType | true | USDT\\_FUTURES USDC\\_FUTURES COIN\\_FUTURES | |
| 103 | +
|
| 104 | +## Code samples: |
| 105 | +
|
| 106 | +```julia |
| 107 | +using CryptoExchangeAPIs.Bitget |
| 108 | +
|
| 109 | +result = Bitget.API.V2.Mix.Market.contracts( |
| 110 | + productType = Bitget.API.V2.Mix.Market.Contracts.SettleType.USDT_FUTURES |
| 111 | +) |
| 112 | +
|
| 113 | +result = Bitget.API.V2.Mix.Market.contracts( |
| 114 | + productType = Bitget.API.V2.Mix.Market.Contracts.SettleType.USDT_FUTURES, |
| 115 | + symbol = "BTCUSDT", |
| 116 | +) |
| 117 | +``` |
| 118 | +""" |
| 119 | +function contracts(client::BitgetClient, query::ContractsQuery) |
| 120 | + return APIsRequest{Data{Vector{ContractsData}}}("GET", "api/v2/mix/market/contracts", query)(client) |
| 121 | +end |
| 122 | + |
| 123 | +function contracts( |
| 124 | + client::BitgetClient = Bitget.BitgetClient(Bitget.public_config); |
| 125 | + kw..., |
| 126 | +) |
| 127 | + return contracts(client, ContractsQuery(; kw...)) |
| 128 | +end |
| 129 | + |
| 130 | +end |
0 commit comments