REST v20 API troubleshooting guide

Before you can access your account on OANDA’s REST v20 API, you must first generate a personal access token. To do this, follow these steps:

1. Log in to your live or demo account in the HUB.

2. On the top, click on Tools and then on API.

   

3. Click on Generate.

   

4. Below ‘Your key to OANDA’s API’, a combination of letters and numbers will appear. This is your API access token. Copy the entire line of text and use it to authenticate your account on the REST v20 API application.

5. To revoke access to the current token, click on Revoke. If you have added any additional sub-accounts to your REST v20 API account, you will also need to revoke and generate a new token to access them through the REST v20 API.

The most common reason for this error message is that you may have used the incorrect endpoint for your request.

If you are using a live account, use the following endpoint: https://api-fxtrade.oanda.com.

If you are using a demo account, use the following endpoint: https://api-fxpractice.oanda.com.

When your JAR files for dependent libraries are out of date, you may receive this error while executing Java code. This can be independent of the fact that your accountID and token are still working with the REST v20 API curl commands.

The solution is to:

1. Upgrade all libraries

2. Delete the external JAR files

3. Reload them from the internet.

The following list shows current libraries you may refer to:

1. common-logging-1.1.1.jar

2. gson-2.6.2.jar

3. httpclient-4.0-alpha4.jar

4. httpclient-4.3.5.jar

5. httpcore-4.3.2.jar

6. v20-3.0.21.jar

7. JRE System Library

8. Maven Dependencies (junit-3.8.1.jar)

oandapyV20 is a third-party wrapper, not supported by OANDA.

We have a v20 Python wrapper available on the developer website for our API clients.

You will need to confirm that the following information is correct:

1. The URL provided to the curl command is correct. If you are using a live account, confirm that you are using https://api-fxtrade.oanda.com.

   In your sample code, the default for environment is set to demo. You should confirm that you have changed it to live. You will need to edit the following code:

   client = oandapyV20.API(access_token=access_token,environment="live")

2. Ensure the authentication token is valid and has been added as a bearer token in the HTTP authorization header.

The most common reason for this error is that you have used an invalid accountID in your request. To locate your correct accountID, follow these steps:

1. Log in to your live or demo account in the HUB.

2. From the left navigation bar, click on Accounts.

   

3. Click on the desired account

4. The number in the format of xxx-xxx-xxxxxxx-xxx next to v20 Account Number is your accountID.

   

OANDA’s historical data differs from live data as we offer different pricing segments and account types. For this reason, the live pricing feed of the API could be different from the historical data retrieved from the API.

This is because the ‘candle’ endpoint used to retrieve historical data only provides base-price group candlestick data. The price polling and streaming endpoints are used to retrieve live data, which uses your account_id to provides live data based on your specific pricing group.

Because an order is changed to a trade once it is filled, using get - /v3/accounts/{accountID}/orders may return an empty order list.

Changing the default condition of orderstatefilter to all will allow you to use get /v3/accounts/{accountID}/orders even when the orders have been filled.

The values used for OrderAn instruction to buy or sell an instrument under the specified conditions State Filter are available on our API documentation.

You cannot create OHLC candlestick data using the REST v20 Stream endpoint, since open, high, low, and close data of the period are not guaranteed to be returned in the response packets. The instrument/candles endpoint probes the server to receive data once a bar is closed. The candle endpoint can thus be used to create accurate candle data with all the bar's activity.