Nebula by Exberry Admin API

Number of APIs: 32

Exberry admin API allows to manage the Nebula by Exberry system, including static data (Accounts, Assets, Instruments and more).

Sandbox environment endpoint (URL_ORIGIN): https://admin-api.uat.exberry-uat.io

Nebula by Exberry can be configured in few different models, such as with DLT ledger or without etc. as part of the integration process to Exberry, you need to make sure that the integration environment is configured per your specific use case and needs.

Guidelines:

All numbers are stringified unless explicitly mentioned otherwise
Optional fields should be omitted from request if not required
System ignores any additional parameter that are sent on request body but was not specified in this document
In case of multiple parameters sent with different values, system will always use the last value provided

Error Handling

Error response contains the below fields:

Name	Description
code	Error code
message	Error message
path `optional`	path for the specific field generate the error
requiredPermission `optional`	Name of missing permission for that action
instrumentId `optional`	InstrumentId cause the error, relevant for action that affect multiple instruments such as Update Calendar

Error response sample:

{
    "code": 10004,
    "message": "Wrong format",
    "data": {
        "path": [
            "id"
        ]
    }
}

In case of wrong path, generic error will be returned :

{
    "message": "Route not found",
    "code": 1
}

Generic Error Codes

Code	Message
1	Timeout expired/ Exchange is unavailable/ Invalid JSON/ Route not found
10000	Invalid token
10100	Permission denied for exchange [ExchangeID]

API Changes

2023-06-21

NOTE!

we changed the name of field name in account and trader to be userName

2022-08-15

In instruments API server response field name was changed from symbol to exchangeInstrumentSymbol

2022-07-12

Asset entity now have new property: url
All entities id changed from uuid to int

April 2022

Initial version of API released.

Account Actions API - Cancel Order DELETE {{URL_ORIGIN}}/api/broker/accounts/23d06e53-5ff1-4009-9295-14ff46f3770e/orders/40
Authentication API - Get Token POST {{URL_ORIGIN}}/api/auth/token
Assets API - Create Asset POST {{URL_ORIGIN}}/api/broker/assets
Instruments API - Update Instrument PATCH {{URL_ORIGIN}}/api/broker/instruments/302f4901-386f-4a20-b9cd-f79e1fa1ed77
Assets API - Update Asset PATCH {{URL_ORIGIN}}/api/broker/assets/a32f8924-f766-4828-9976-ba52414063a5
Accounts API-API Keys - Delete apiKey DELETE {{URL_ORIGIN}}/api/broker/accounts/1/api-keys/1fae4e12-6d82-483d-8658-475b1278deee
Assets API - Get Asset GET {{URL_ORIGIN}}/api/broker/assets/20
Assets API - Get Assets GET {{URL_ORIGIN}}/api/broker/assets
Instruments API - Create Instrument POST {{URL_ORIGIN}}/api/broker/instruments
Instruments API - Get Instrument GET {{URL_ORIGIN}}/api/broker/instruments/23