Skip to content
Get started

Get News

NewsGetNewsResponse v1().instrumentData().news().getNews(NewsGetNewsParamsparams = NewsGetNewsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/news

Retrieves news items with optional filtering by security IDs, time range, publisher, type, and text query.

ParametersExpand Collapse
NewsGetNewsParams params
Optional<String> excludePublishers

Comma-separated list of publishers to exclude (mutually exclusive with include_publishers).

Optional<String> from

Inclusive start timestamp. Accepts YYYY-MM-DD or RFC3339 datetime.

Optional<String> includePublishers

Comma-separated list of publishers to include (mutually exclusive with exclude_publishers).

Optional<List<String>> instrumentIds

Comma-delimited OEMS instrument UUIDs to filter by.

Optional<NewsType> newsType

Filter by news type.

NEWS("NEWS")
PRESS_RELEASE("PRESS_RELEASE")
Optional<Long> pageSize

The number of items to return per page. Only used when page_token is not provided.

formatint64
maximum1000
minimum1
Optional<String> pageToken

Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.

formatbyte
Optional<String> searchQuery

Free-text query matched against title/text and associated security IDs.

Optional<List<Sector>> sectors

Comma-separated sector values to filter by.

BASIC_MATERIALS("BASIC_MATERIALS")
COMMUNICATION_SERVICES("COMMUNICATION_SERVICES")
CONSUMER_CYCLICAL("CONSUMER_CYCLICAL")
CONSUMER_DEFENSIVE("CONSUMER_DEFENSIVE")
ENERGY("ENERGY")
FINANCIAL_SERVICES("FINANCIAL_SERVICES")
HEALTHCARE("HEALTHCARE")
INDUSTRIALS("INDUSTRIALS")
REAL_ESTATE("REAL_ESTATE")
TECHNOLOGY("TECHNOLOGY")
UTILITIES("UTILITIES")
Optional<String> to

Inclusive end timestamp. Accepts YYYY-MM-DD or RFC3339 datetime.

ReturnsExpand Collapse
class NewsGetNewsResponse:
List<NewsItem> data
List<NewsInstrument> instruments

Instruments associated with this news item.

String instrumentId

OEMS instrument UUID.

formatuuid
Optional<String> name

Instrument name/description, if available from instrument cache enrichment.

Optional<String> symbol

Trading symbol, if available from instrument cache enrichment.

NewsType newsType

Classification of the item.

One of the following:
NEWS("NEWS")
PRESS_RELEASE("PRESS_RELEASE")
LocalDateTime publishedAt

The published date/time of the article in UTC.

formatdate-time
String publisher

The publisher or newswire source.

String title

The headline/title of the article.

String url

Canonical URL to the full article.

Optional<String> imageUrl

URL of an associated image if provided by the source.

Optional<String> site

The primary domain/site of the publisher.

Optional<String> text

The full or excerpted article body.

Get News

package com.clear_street.api.example;

import com.clear_street.api.client.ClearStreetClient;
import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient;
import com.clear_street.api.models.v1.instrumentdata.news.NewsGetNewsParams;
import com.clear_street.api.models.v1.instrumentdata.news.NewsGetNewsResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        NewsGetNewsResponse response = client.v1().instrumentData().news().getNews();
    }
}
{
  "data": [
    {
      "instruments": [
        {
          "instrument_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "name": "Apple Inc.",
          "symbol": "AAPL"
        }
      ],
      "news_type": "NEWS",
      "published_at": "2025-10-31T14:30:00.000000000Z",
      "publisher": "Reuters",
      "site": "reuters.com",
      "title": "Apple announces new hardware lineup",
      "url": "https://example.com/news/1"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": "cGFnZT0yJmxhc3Rfc3ltYm9sPVRTM0E",
    "page_number": 1,
    "request_id": "0f1a2b3c-4d5e-6f78-9012-3a4b5c6d7e8f",
    "total_items": 25,
    "total_pages": 3
  }
}
{
  "error": {
    "code": 400,
    "message": "Failed to deserialize query string: from: invalid date or datetime '123': expected YYYY-MM-DD or RFC3339 (e.g. 2025-01-30T14:30:00Z)"
  },
  "metadata": {
    "request_id": "d706b33d-ef0c-484d-a5e5-2f8b68ecb203"
  }
}
Returns Examples
{
  "data": [
    {
      "instruments": [
        {
          "instrument_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "name": "Apple Inc.",
          "symbol": "AAPL"
        }
      ],
      "news_type": "NEWS",
      "published_at": "2025-10-31T14:30:00.000000000Z",
      "publisher": "Reuters",
      "site": "reuters.com",
      "title": "Apple announces new hardware lineup",
      "url": "https://example.com/news/1"
    }
  ],
  "error": null,
  "metadata": {
    "next_page_token": "cGFnZT0yJmxhc3Rfc3ltYm9sPVRTM0E",
    "page_number": 1,
    "request_id": "0f1a2b3c-4d5e-6f78-9012-3a4b5c6d7e8f",
    "total_items": 25,
    "total_pages": 3
  }
}
{
  "error": {
    "code": 400,
    "message": "Failed to deserialize query string: from: invalid date or datetime '123': expected YYYY-MM-DD or RFC3339 (e.g. 2025-01-30T14:30:00Z)"
  },
  "metadata": {
    "request_id": "d706b33d-ef0c-484d-a5e5-2f8b68ecb203"
  }
}