Options

This section give's control and information for the system's options.
Option is row in the DB with key and value.
Options can be changed only be approved admin.
Some options must be setted in the DB, before users can log in.
Admin logged in - can see an update any option setted in the DB.
User logged in - has access to specific authorized options.

gett-all-options-list

Get list of all db options

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

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

post-new-option

Add a new option to the db

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)

name
string
value
string
return_parameter_type
string
Responses
200

Success

401

Unauthorized

403

Forbidden

422

Unprocessable Content

post/options
Request samples
application/json
{
  • "name": "new_option_name",
  • "value": "new_option_value",
  • "return_parameter_type": "string"
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

get-exact-option

Returns a value from the options db by option_id

SecurityAuthorization
Request
path Parameters
option_id
required
string

option_id path parameter

Example: <option_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/options/{option_id}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

update-exact-option

Update option using option_id

SecurityAuthorization
Request
path Parameters
option_id
required
string

option_id path parameter

Example: <option_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)

name
string
value
number
return_parameter_type
string
Responses
200

Success

401

Unauthorized

403

Forbidden

422

Unprocessable Content

put/options/{option_id}
Request samples
application/json
{
  • "name": "fee_volume_time_group",
  • "value": 30,
  • "return_parameter_type": "number"
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

delete-exact-option

Delete specific option from the DB by option_id

SecurityAuthorization
Request
path Parameters
option_id
required
string

option_id path parameter

Example: <option_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/options/{option_id}
Response samples
application/json
{ }

get-exact-option-vaule

Returns a value from the options db by option_name

SecurityAuthorization
Request
path Parameters
option_name
required
string

option_name path parameter

Example: <option_name>
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/options/name/{option_name}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

udpate-exact-option-value

Update option using option_name

SecurityAuthorization
Request
path Parameters
option_name
required
string

option_name path parameter

Example: <option_name>
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)

value
string
Responses
200

Success

401

Unauthorized

403

Forbidden

422

Unprocessable Content

put/options/name/{option_name}
Request samples
application/json
{
  • "value": "new_option_value"
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}

verify-trading-password

Check if the trading password is valid

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)

password
string
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable Content

post/options/verifyTradingPassword
Request samples
application/json
{
  • "password": "Password890!@#"
}
Response samples
application/json
{
  • "api_message": "OPTION_POST_VALIDATE_TRADING_PASSWORD_SUCCESS",
  • "api_data": {
    }
}

update-trading-password

Update TradingPassword

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)

old_password
string
new_password
string
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable Content

put/options/updateTradingPassword
Request samples
application/json
{
  • "old_password": "Password890!@#",
  • "new_password": "NewPassword123!@#"
}
Response samples
application/json
{
  • "api_message": "<string>",
  • "api_data": {
    }
}