News API

Market news sentiment per currency or instrument

Changed on

Counts the per symbol sentiment of the articles published in the range. Without from/to the last 24 hours are used, the range is at most 31 days. Articles summarised before per symbol sentiment existed are not counted.

get/rest/api/v1/projects/{projectId}/marketNews/sentiment

Request

Path parameters

projectIdstring uuid required

Query parameters

fromstring

Published at or after (ISO-8601 UTC)

tostring

Published before (ISO-8601 UTC)

symbolsstring

Comma separated currency or instrument codes, all when omitted

impactstring

Minimum article impact: LOW, MEDIUM or HIGH

categorystring

Feed category: forex, markets, crypto, indicators or general

Response

OK

articlesinteger

Articles with a per symbol sentiment that were counted

fromUtcstring date-time

Start of the range (publication time, UTC)

toUtcstring date-time

End of the range (publication time, UTC)

truncatedboolean

True when the range held more articles than are counted in one call. Only the newest are included, narrow the range for a complete count

Example response

{
  "articles": 184,
  "symbols": [
    {
      "articles": 20,
      "bearish": 4,
      "bullish": 11,
      "neutral": 5,
      "score": 0.35,
      "sentiment": "BULLISH",
      "symbol": "JPY"
    }
  ]
}

Changes