Powered by Redocly

FeeRules

This section give's control over the system's fee rules.
Fee rule must be setted before trying to perform any trading action.
Fee rule must have specified volume (range) and a Fee percentage / Min. Fee / Fixed fee.
Fee rules can be different for every currency or side (Buy / Sell).
Admin logged in - can create new fee rules per every currency available in his system,delete or edit any fee rule.
User logged in - user don't have access to fee rules settings.

get-feerules-list

Returnes a list of the current fee rules setted.

SecurityAuthorization
Request
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
200

Success

401

Unauthorized

403

Forbidden

get/feerules
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

post-feerule

Create a new feerule for the provided liquidity.

SecurityAuthorization
Request
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Request Body schema: application/json
required

raw(json)

liquidity_id
string
base_currency
string
quote_curreny
string
markup_percent
number
markup_fixed
number
markup_min
number
from_volume
number
to_volume
number
side
string
Responses
200

Success

401

Unauthorized

403

Forbidden

422

Unprocessable Content

post/feerules
Request samples
application/json
{
  • "liquidity_id": "WlBPdmtSY2hITGM9",
  • "base_currency": "BTC",
  • "quote_curreny": "USD",
  • "markup_percent": 2.5,
  • "markup_fixed": 2.5,
  • "markup_min": 2.5,
  • "from_volume": 750,
  • "to_volume": 2000,
  • "side": "Buy"
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": null
}

get-exact-feerule

Getting exact feerule row by id

SecurityAuthorization
Request
path Parameters
id
required
string

feerule_id path parameter

Example: <feerule id>
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
200

Success

401

Unauthorized

403

Forbidden

get/feerules/{id}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

update-exact-feerule

Update specific rule row by feerule_id.

SecurityAuthorization
Request
path Parameters
id
required
string

feerule_id path parameter

Example: <feerule id>
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Request Body schema: application/json
required

raw(json)

liquidity_id
string
base_currency
string
quote_curreny
string
markup_percent
number
markup_fixed
number
markup_min
number
from_volume
number
to_volume
number
side
string
Responses
200

Success

401

Unauthorized

403

Forbidden

422

Unprocessable Content

put/feerules/{id}
Request samples
application/json
{
  • "liquidity_id": "WlBPdmtSY2hITGM9",
  • "base_currency": "BTC",
  • "quote_curreny": "USD",
  • "markup_percent": 2.5,
  • "markup_fixed": 2.5,
  • "markup_min": 2.5,
  • "from_volume": 750,
  • "to_volume": 2000,
  • "side": "Buy"
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

delete-exact-feerule

Delete specific fee rule by feerule_id.

SecurityAuthorization
Request
path Parameters
id
required
string

feerule_id path parameter

Example: <feerule id>
header Parameters
Authorization
required
string

auth header for JWT

Example: <JWT token>
username
required
string

auth header for username

Example: <username>
Responses
204

No Content (Success)

401

Unauthorized

403

Forbidden

delete/feerules/{id}
Response samples
application/json
{ }
➔ Next to Ledger