Skip to main content

Retail Services Onboarding Guide


The scheme below briefly describes the overall process of delivering market data to end users via your application using our service.


Our system consists of two independent services:

  • dxFeed Retail Services responsible for subscription management, entitlement control, and reporting

  • dxFeed endpoint providing data feeds

The cooperation takes three steps:

  • Integration when we prepare a trial connection and provide you with technical details

  • Testing when you are able to check the whole scenario in a set-up demo environment

  • Production release

Follow the instructions below to proceed with the service implementation process.

Integration and Testing


During the integration stage, we prepare a trial connection on the environment and provide you with technical details.


To make the integration process smoother, we ask you to:

  1. Answer the Questionnaire

  2. If desired, a partner sends us a bitmap logo of their platform for light and dark modes so that we are able to brand the personal data form for a user. It's optional

  3. Let us know if you need to enable callbacks and mail us a URL address to send the callback to. On our side, three events invoke callbacks:

    1. Subscription activation — a subscription has been activated for a user as soon as they provide all the required information, including personal data. The callback includes account ID and the subscription names together with their end dates

    2. Credentials generation — if your application generates credentials (see the Questionnaire), we forward the credentials to a user via email. We also send you a callback whenever a new account generates credentials. The callback includes the account ID, login, and password

    3. Subscriber status setting — a user has defined a status in the onboarding wizard form. The callback includes the account ID and subscriber status (pro or non-pro)

If you have chosen to enable any callback(s), you should email us the required callback(s) and attach a valid URL address. You may also send us a bitmap logo to brand the onboarding wizard form.

Learn more about the Retail Services Callbacks

Trial data endpoints

We open a trial data server for you depending on the type of products you have ordered, like real-time data, historical candle data, etc.


Data Server

Real-time data feed trial server

Historical candle data/TimeAndSale server

Instrument Profile Format (IPF) trial server


For safety reasons, get.dxFeed generates a unique alphanumeric string, or API key. This key is used for authorization and sent in the authorization header for requests in our collections.

We will email you a trial API key with all necessary request parameters once the staging environment is ready.

To help us prepare the staging environment, we ask you to fill in the Questionnaire and email us other relevant information.

Subscription management API

You can find the subscription and account management collection of API requests on the get.dxfeed Services API page.get.dxfeed Services Overview

Use your trial API key from the email for the authorization header and send requests to the server.

Trial authorization and token generation

The application should request a token from the get.dxFeed portal every time a user logs in to the system.

Send this request from our collection to request an access token.get.dxfeed Services Overview

Data request at dxFeed

After you receive a token, it is possible to establish a connection with the dxFeed endpoint where a user requests data. 

Choose an API function based on your needs: Java, C, C#, JavaScript, WebSocket, or REST.


Add auther-api.jar to the application’s classpath:

String address = <IP address>:<host port>[login=entitle:" + token + "];

Or set a global variable and use a shorter connection string:

address = "<IP address>:<host port>[login=entitle]";


dxf_create_connection_auth_bearer() function.


NativeConnection (string address, string token, Action<DxConnection> disconnectListener) constructor of com.dxfeed.native.NativeConnection class.

JavaScript (dxfeed.cometd.js library) API request


WebSocket (on ws-handshake) API request

{ ext: { "com.devexperts.auth.AuthToken": <token> }}

REST API request

Specify token in the HTTP-header:

Authorization: Bearer <token>

The full collection of APIs is available on the dxFeed Java API page.


This is the stage where we check and test the whole E2E scenario. Follow the instructions below:

  1. Provide us with test access to your platform to verify compliance with exchange requirements. This also allows our support team to address user support requests

  2. Confirm whether you want us to open access to the back office where you can manage accounts and subscriptions to the demanded feeds via user interface

Compliance with regulatory requirements


Algo-trading, real-time data streaming, and real-time data export are strongly prohibited.

If your platform provides such functionality, it has to be deactivated when establishing a connection to dxFeed.


Note that due to existing regulatory requirements, you need to add the dxFeed logo to your application/platform to the following places:

  • The login window

  • The About/Help section

  • The bottom of every window that shows dxFeed market data

The logo must be shown when the connection is established. Please see possible ways of placing the logo in the examples below.

Check the dxFeed logo.

dxFeed logo in the login window:


dxFeed logo in the About section:


dxFeed logo at the bottom of the page with dxFeed market data:



Production is the last stage of the process.

After you have tested our functionality and had all technical issues resolved, we grant you access to the production environment and provide you with:

  • An API key for the production environment

  • Real market data endpoints

Additional Functionality

Back Office

If your business needs a more personalized approach to client services and manual subscription management, dxFeed can offer you the Back Office.

Our Back Office provides a user-friendly interface and functionality for managers and administrators. It can even replace subscription management API methods.

It is specially adjusted for your needs and allows you to create user accounts, view account details, and manage subscriptions.