News API

Get market news articles

Changed on

Headline and summary are written by MetaCopier from the source article, the publisher's own text is never served. Articles that have not been summarised yet are not returned at all.

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

Request

Path parameters

projectIdstring uuid required

Query parameters

categorystring

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

impactstring

Minimum impact: LOW, MEDIUM or HIGH

sentimentstring

BEARISH, NEUTRAL or BULLISH. Combined with currencies it is matched per currency, so JPY and BULLISH finds articles where the yen is bullish

currenciesstring

Comma separated currency codes

searchstring

Case insensitive substring of the headline or summary

bookmarkedboolean

Only the articles this project has bookmarked

fromstring

Published at or after (ISO-8601 UTC)

tostring

Published before (ISO-8601 UTC)

pageinteger

Zero based page index

sizeinteger

Page size, maximum 100

Response

OK

pageinteger

Zero based page index

sizeinteger

Page size

totalinteger

Total number of matching articles

Example response

{
  "items": [
    {
      "category": "forex",
      "currencies": [
        "USD"
      ],
      "instruments": [
        "XAU"
      ],
      "sentimentBySymbol": {
        "JPY": "BEARISH",
        "USD": "BULLISH"
      }
    }
  ],
  "size": 25,
  "total": 212
}

Changes

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter to

    • info

      added the optional property // to the response with the status

    • info

      endpoint added