Table of content

• 1 Introduction
• 2 Sentiment
  • 2.1 Technical Sentiment
    • 2.1.1 Request
    • 2.1.2 Response Body
      • 2.1.2.1 Successful example response
      • 2.1.2.1 Failed example response
  • 2.2 Trader Sentiment
    • 2.2.1 Request
    • 2.2.2 Response Body
      • 2.2.2.1 Successful example response
      • 2.2.2.1 Failed example response
• 3 Economic Calendar
  • 3.1 Economic Calendar Options
    • 3.1.1 Request
    • 3.1.2 Response Body
      • 3.1.2.1 Successful example response
      • 3.1.2.1 Failed example response
  • 3.2 Economic Calendar
    • 3.2.1 Request
    • 3.2.2 Response Body
      • 3.2.2.1 Successful example response
      • 3.2.2.1 Failed example response

1 Introduction

This Forex API delivers live currency rates, economic news, and both market sentiment indicators and real trader sentiment.

Gain access to:

Live Forex Data:
Economic News Calendar: Stay informed about upcoming and historical economic events that can impact currency valuations.

Forex Sentiment Analysis:
Technical Sentiment: Gain insights into market sentiment through established metrics from widely used indicators.
Trader Sentiment: Understand how real forex traders are feeling about the market through current trades.

2 Sentiment

By combining technical and trader sentiment analysis, you can:

• Make informed trading decisions: Gain a more comprehensive understanding of market sentiment beyond just price action.
• Refine your trading strategy: Use this data as a valuable piece of the puzzle alongside technical and fundamental analysis.
• Navigate Market Psychology: Understand both the technical signals and the “herd mentality” that can influence market movements.

2.1 Technical Sentiment

Technical Sentiment: Gain insights into market sentiment through established metrics from widely used indicators.

2.1.1 Request

Currently no parameters are required, you will get a response with all major and some minor currency pairs.

2.1.2 Response Body

Key	Type	Description	Example
symbols	Array	Array of objects with sentiment and trading information.	-
symbols.symbol	String	Currency pair.	“symbol”: “AUDCAD”
symbols.lastTradePrice	Number	Last price of the pair.	“lastTradePrice”: 0.89309
symbols.todaysOpinion	String	BUY or SELL.	“todaysOpinion”: “Buy”
symbols.todaysOpinionPercentage	Number	Strenght of the opinion in percentage.	“todaysOpinionPercentage”: 64
hasError	Boolean	Boolean to check for errors.	false
errors	Array	An array of error messages.	“errors”: [“Example error message”]

2.1.2.1 Successful example response

{
  "symbols": [
    {
      "symbol": "AUDCAD",
      "lastTradePrice": 0.89309,
      "todaysOpinion": "Buy",
      "todaysOpinionPercentage": 64
    },
    {
      "symbol": "AUDCHF",
      "lastTradePrice": 0.5975,
      "todaysOpinion": "Buy",
      "todaysOpinionPercentage": 100
    },
    {
      "symbol": "AUDEUR",
      "lastTradePrice": 0.61095,
      "todaysOpinion": "Buy",
      "todaysOpinionPercentage": 56
    },
    ...
  ],
  "hasError": false,
  "errors": []
}

2.1.2.1 Failed example response

{
  "symbols": [],
  "hasError": true,
  "errors": ["Example error message"]
}

2.2 Trader Sentiment

Trader Sentiment: Understand how real forex traders are feeling about the market through current trades.

2.2.1 Request

Currently no parameters are required, you will get a response with all major and some minor currency pairs.

2.2.2 Response Body

Key	Type	Description	Example
symbols	Array	Array of objects with sentiment and trading information.	-
symbols.symbol	String	Currency pair.	“symbol”: “EURUSD”
symbols.longTrades	Object	Information on the long trades.	-
symbols.longTrades.percentage	Number	Strenght of the long trades in percentage.	“percentage”: 45
symbols.longTrades.positions	Number	Amount of long trade positions.	“positions”: 32414
symbols.longTrades.volumeLots	Number	Amount of long trade lots.	“volumeLots”: 7614.51
symbols.shortTrades	Object	Information on the short trades.	-
symbols.shortTrades.percentage	Number	Strenght of the short trades in percentage.	“percentage”: 45
symbols.shortTrades.positions	Number	Amount of short trade positions.	“positions”: 32414
symbols.shortTrades.volumeLots	Number	Amount of short trade lots.	“volumeLots”: 7614.51
symbols.totalTrades	Object	Information on all trades combined.	-
symbols.totalTrades.positions	Number	Amount of all trade positions.	“positions”: 32414
symbols.totalTrades.volumeLots	Number	Amount of all trade lots.	“volumeLots”: 7614.51
hasError	Boolean	Boolean to check for errors.	false
errors	Array	An array of error messages.	“errors”: [“Example error message”]

2.2.2.1 Successful example response

{
  "symbols": [
    {
      "symbol": "EURUSD",
      "longTrades": {
        "percentage": 45,
        "positions": 32414,
        "volumeLots": 7614.51
      },
      "shortTrades": {
        "percentage": 55,
        "positions": 33905,
        "volumeLots": 9454.75
      },
      "totalTrades": {
        "positions": 66319,
        "volumeLots": 17069.26
      }
    },
    {
      "symbol": "GBPUSD",
      "longTrades": {
        "percentage": 23,
        "positions": 11202,
        "volumeLots": 2965.71
      },
      "shortTrades": {
        "percentage": 77,
        "positions": 32636,
        "volumeLots": 10190.61
      },
      "totalTrades": {
        "positions": 43838,
        "volumeLots": 13156.32
      }
    },
    {
      "symbol": "USDJPY",
      "longTrades": {
        "percentage": 21,
        "positions": 4058,
        "volumeLots": 1007.21
      },
      "shortTrades": {
        "percentage": 79,
        "positions": 13000,
        "volumeLots": 3891.89
      },
      "totalTrades": {
        "positions": 17058,
        "volumeLots": 4899.1
      }
    },
    ...
  ],
  "hasError": false,
  "errors": []
}

2.2.2.1 Failed example response

{
  "symbols": [],
  "hasError": true,
  "errors": ["Example error message"]
}

3 Economic Calendar

Economic News Calendar: Stay informed about upcoming and historical economic events that can impact currency valuations.

3.1 Economic Calendar Options

Get information on all supported countries and volatilities

3.1.1 Request

No body or request parameters are necessary for this request.

3.1.2 Response Body

Key	Type	Description	Example
allowedCountries	Array[String]	Array of all supported country ISO codes.	“allowedCountries”: [“US”,“UK”,“EMU”,“DE”,…]
allowedVolatilities	Array[String]	Array of the allowed volatility filter for the news.	“allowedVolatilities”: [“NONE”,“LOW”,“MEDIUM”,“HIGH”]
hasError	Boolean	Boolean to check for errors.	false
errors	Array	An array of error messages.	“errors”: [“Example error message”]

3.1.2.1 Successful example response

{
  "allowedCountries": [
    "US",
    "UK",
    "EMU",
    "DE",
    ...
  ],
  "allowedVolatilities": [
    "NONE",
    "LOW",
    "MEDIUM",
    "HIGH"
  ],
  "hasError": false,
  "errors": []
}

3.1.2.1 Failed example response

{
  "allowedCountries": [],
  "allowedVolatilities": [],
  "hasError": true,
  "errors": ["Example error message"]
}

3.2 Economic Calendar

Get upcoming news and economic events

3.2.1 Request

Key	Type	Description	Is required	Example
includeVolatilities	String (Semicolon separated)	Filter results by only returning specific impact on a currency. Can be empty if every volatility-impact needs to be returned. You can set multiple volatilities by seperating them with a semicolon. Check out the Economic Calendar Options for all allowed values	No	includeVolatilities=NONE;LOW;MEDIUM;HIGH
includeCountries	String (Semicolon separated)	Filter results by specific countries. Can be empty if every country will be returned. You can set multiple countries by seperating them with a semicolon. Check out the Economic Calendar Options for all allowed values	No	includeCountries=US;UK;DE

3.2.2 Response Body

Key	Type	Description	Example
calendarEntries	Array[Object]	Array of all calendar entries.	-
calendarEntries.id	String	ID of the event.	“id”: “336276b9-52ae-4f89-b674-7faf6e81a547”
calendarEntries.name	String	Name of the event.	“name”: “ECB’s President Lagarde speech”
calendarEntries.dateUtc	String	UTC date of when the event will happen or happened.	“dateUtc”: “2024-04-22T15:30:00Z”
calendarEntries.countryCode	String	ISO code of the affected country.	“countryCode”: “EMU”
calendarEntries.currencyCode	String	The affected currency.	“currencyCode”: “EUR”
calendarEntries.volatility	String	The impact of the event, see Economic Calendar Options for all volatilities.	“volatility”: “HIGH”
calendarEntries.unit	String OR Null	Type of the value.	“unit”: “%”
calendarEntries.actual	Number OR Null	The actual value of the result.	“actual”: 0.3
calendarEntries.consensus	Number OR Null	The expected value of the result.	“consensus”: 0.3
calendarEntries.previous	Number OR Null	The previous value of the last event.	“previous”: 0.3
calendarEntries.revised	Number OR Null	The revised value of the actual value in case of changes.	“revised”: 0.2
hasError	Boolean	Boolean to check for errors.	false
errors	Array	An array of error messages.	“errors”: [“Example error message”]

3.2.2.1 Successful example response

{
  "calendarEntries": [
    {
      "id": "336276b9-52ae-4f89-b674-7faf6e81a547",
      "name": "ECB's President Lagarde speech",
      "dateUtc": "2024-04-22T15:30:00Z",
      "countryCode": "EMU",
      "currencyCode": "EUR",
      "volatility": "HIGH",
      "unit": null,
      "actual": null,
      "consensus": null,
      "previous": null,
      "revised": null
    },
    {
      "id": "ef805630-c0c6-4ad5-9753-bc23ab3d1cc7",
      "name": "HCOB Composite PMI",
      "dateUtc": "2024-04-23T07:30:00Z",
      "countryCode": "DE",
      "currencyCode": "EUR",
      "volatility": "HIGH",
      "unit": null,
      "actual": 50.5,
      "consensus": 48.6,
      "previous": 47.7,
      "revised": null
    },
    {
      "id": "19e3a9a9-8eeb-4e57-8ac2-75ebd612da4c",
      "name": "HCOB Manufacturing PMI",
      "dateUtc": "2024-04-23T07:30:00Z",
      "countryCode": "DE",
      "currencyCode": "EUR",
      "volatility": "HIGH",
      "unit": null,
      "actual": 42.2,
      "consensus": 42.8,
      "previous": 41.9,
      "revised": null
    },
    {
      "id": "ea182eb3-279d-4ce7-8d63-a5dfa072ed2a",
      "name": "HCOB Services PMI",
      "dateUtc": "2024-04-23T07:30:00Z",
      "countryCode": "DE",
      "currencyCode": "EUR",
      "volatility": "HIGH",
      "unit": null,
      "actual": 53.3,
      "consensus": 50.6,
      "previous": 50.1,
      "revised": null
    },
    {
      "id": "4787fca5-ed04-48ef-ab55-e7cb7dea7941",
      "name": "HCOB Composite PMI",
      "dateUtc": "2024-04-23T08:00:00Z",
      "countryCode": "EMU",
      "currencyCode": "EUR",
      "volatility": "HIGH",
      "unit": null,
      "actual": 51.4,
      "consensus": 50.8,
      "previous": 50.3,
      "revised": null
    },
    ...
  ],
  "hasError": false,
  "errors": []
}

3.2.2.1 Failed example response

{
  "calendarEntries": [],
  "hasError": true,
  "errors": ["Example error message"]
}