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.
{- "api_message": "<string>",
- "api_data": [
- {
- "id": "<string>",
- "name": "<string>",
- "value": "<string>",
- "return_parameter_type": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
]
}
Add a new option to the db
Success
Unauthorized
Forbidden
Unprocessable Content
{- "name": "new_option_name",
- "value": "new_option_value",
- "return_parameter_type": "string"
}
{- "api_message": "<string>",
- "api_data": {
- "option": {
- "id": "<string>",
- "name": "<string>",
- "value": "<string>",
- "return_parameter_type": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}
Returns a value from the options db by option_id
Success
Unauthorized
Forbidden
{- "api_message": "<string>",
- "api_data": {
- "option": {
- "id": "<string>",
- "name": "<string>",
- "value": "<string>",
- "return_parameter_type": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}
Update option using option_id
raw(json)
Success
Unauthorized
Forbidden
Unprocessable Content
{- "name": "fee_volume_time_group",
- "value": 30,
- "return_parameter_type": "number"
}
{- "api_message": "<string>",
- "api_data": {
- "option": {
- "id": "<string>",
- "name": "<string>",
- "value": "<string>",
- "return_parameter_type": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}
Returns a value from the options db by option_name
Success
Unauthorized
Forbidden
{- "api_message": "<string>",
- "api_data": {
- "option": {
- "id": "<string>",
- "name": "<string>",
- "value": "<string>",
- "return_parameter_type": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}
Update option using option_name
raw(json)
Success
Unauthorized
Forbidden
Unprocessable Content
{- "value": "new_option_value"
}
{- "api_message": "<string>",
- "api_data": {
- "option": {
- "id": "<string>",
- "name": "<string>",
- "value": "<string>",
- "return_parameter_type": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}
Check if the trading password is valid
Success
Bad Request
Unauthorized
Forbidden
Unprocessable Content
{- "password": "Password890!@#"
}
{- "api_message": "OPTION_POST_VALIDATE_TRADING_PASSWORD_SUCCESS",
- "api_data": {
- "vaild": ""
}
}
Update TradingPassword
Success
Bad Request
Unauthorized
Forbidden
Unprocessable Content
{- "old_password": "Password890!@#",
- "new_password": "NewPassword123!@#"
}
{- "api_message": "<string>",
- "api_data": {
- "option": {
- "id": "<string>",
- "name": "<string>",
- "value": "<string>",
- "return_parameter_type": "<string>",
- "created_at": "<datetime string>",
- "updated_at": "<datetime string>"
}
}
}