settings/setOvernightRates

Returns snapshot of overnight rates.

Setting overnight rates method is applicable for makers/masters only. It is possible to set a specific overnight rate.

After the change is done, every affected counterparty/sub-account will be notified about a change by email within 10 minutes.

POST api/settings/set_overnight_rates

// Set overnight rates
{ 
 "counterpartyId": 2, // counterpartyId or counterpartyGroup
 "currencyGroup": "fiat", // currencyId or currencyGroup
 "negativeRate": 10, // negative rate value
 "positiveRate": 0 // positive rate value
 }

// Reset overnight rates
{
 "counterpartyId": 2, // counterpartyId or counterpartyGroup
 "currencyGroup": "fiat" // currencyId or currencyGroup
}

Request parameters

Field nameTypeDescription

counterpartyId

ClientId

Optional. Counterparty ID if setting the rate for a specific counterparty.

counterpartyGroup

string

Optional. Counterparty group if setting the rate for a group of counterparties. Values: 'all', 'externalTakers', 'externalMakers', 'externals', 'subaccountTaker', 'subaccountMaker', 'subaccounts'

currency

string

Currency name

currencyGroup

string

Optional. CurrencyGroup if setting the rate for a group of currencies. Values: 'all', 'fiat', 'crypto', 'stablecoin'

negativeRate

unsigned int32

Optional. Negative rate, min vaue=100=1 bps = 0.01% If both negative and positive are in a request, then rates will be set. If both rates are missing, rates will be deleted.

positiveRate

unsigned int32

Optional. Positive rate, min vaue=100=1 bps = 0.01% If both negative and positive are in a request, then rates will be set. If both rates are missing, rates will be deleted.

Last updated