Getting Started
Step 1: Developer account
Before using any API on the portal, you must contact your firm's StoneX relationship manager. They will start the registration process and connect you with one of our development resources to setup your credentials.
Step 2: Save your credentials
Once your user has been created you will be issued the below credentials needed to utilize the APIs:
- Username & Password: This is your username and password to access the Developer Portal.
- Client ID and Client Secret: These credentials are used to obtain a user Access Token with OAuth 2.0 authentication. Learn more about this process in our Authentication section.
- Subscription Key(s): The StoneX APIs are seperated into multiple products. Each one requires a subscription key that grants access to that particular product. See how to use the subscription key the next section.
Since the subscription keys do not expire unless regenerated, we suggest that you save them in a secure location, such as a password manager, once you've received your credentials.
If you misplace or forget the subscription keys, you will need to regenerate them, which creates new credentials and invalidates the old ones. This means that you will have to update any integrations that you may have set up with your prior credentials.
Step 3: Your first request
What's next? Let's make your first request to the API!
We have guides, examples, and references to help you get started. The following pages will help you get started with Authentication and understanding the general structure of our API suite.
Step 4: Testing
Use the StoneX provided test environment to develop your application against.
Step 5: Production Ready
Once your app is built, tested, and production ready. Reach back out to us to begin you production verification process. Here we will run through a check list of your apps functionality and ensure it complies with our policies. Then you will be issued a new set of Production credentials.