API Reference

Generate API Key and Secret

REST Key

In order to use the REST API, users must generate an API key and secret.

Via OSL Website

  1. Log in to your account from the OSL website and click on the SETTINGS link in the top-right profile icon.
  2. Then click API followed by CREATE. If two-factor authentication is enabled, enter the one-time password (OTP).
  3. The REST API key and secret will be displayed. You can toggle "Move Funds" and "Place and "Manage Orders" permissions as required.
  4. If these are set toggled OFF the keys are considered to be Read Only API Keys.
  1. If your account has any associated subacounts they will appear here.
    1. The API Key has the ability to control all account groups if no subaccount is specified.
    2. If one subaccount is selected then the API has the ability to control only that account.

🚧

The API secret will only be shown once and will not be retrievable once you click SAVE.

If you forget/lose your API secret, you will have to click RESET SECRET. The old API secret will be disabled automatically once the secret is reset.

Multiple REST API keys can be created as per the user requirements.