Stock News

Use NewsClient to get stock news and market highlights. Follow this SDK's quickstart to configure the client. News queries use the main gateway and do not take over real-time quote device access.

getStockNews

getStockNews(req: NewsStockListRequest): Promise<NewsPage>

Description

Gets news for one stock using news_stock_list. Only one symbol is supported. Paginate using the page number and page size; the first page starts with the latest articles.

Parameters

Parameter	Type	Required	Description
`req.symbol`	`string`	Yes	One stock symbol, such as `AAPL`
`req.lang`	`string`	No	Uses the client language when omitted; supported values are `zh_CN` / `zh_TW` / `en_US`
`req.pageCount`	`number`	No	`undefined` is omitted; the server defaults to 1. Explicit values must be at least 1
`req.pageSize`	`number`	No	`undefined` is omitted; the server defaults to 20. Explicit values must be 1–50

Returns

Promise<NewsPage>; the promise rejects on failure.

Field	Type	Description
`items`	`NewsItem[]`	Articles on the current page
`pageCount`	`number \| undefined`	Current page number; always 1 for market highlights
`pageSize`	`number \| undefined`	Page size
`totalPage`	`number \| undefined`	Total page count
`totalSize`	`number \| undefined`	Total item count

Each news item has the following fields:

Field	Type	Description
`id`	`string \| undefined`	Article ID; can be used as the cursor for the next market-highlights page
`title`	`string \| undefined`	Title
`summary`	`string \| undefined`	Summary
`pubTimestamp`	`number \| undefined`	Publication time, as a Unix timestamp in seconds
`url`	`string \| undefined`	Article URL

Example

import { createClientConfig, NewsClient } from '@tigeropenapi/tigeropen';

async function main(): Promise<void> {
    const config = createClientConfig();
    const newsClient = NewsClient.fromConfig(config);
    const page = await newsClient.getStockNews({ symbol: 'AAPL', lang: 'en_US', pageCount: 1, pageSize: 20 });
    for (const item of page.items) console.log(item.pubTimestamp, item.title, item.url);
}

void main();

Response example

This JSON example is based on fixed SDK test fixtures and illustrates the response data structure. Actual calls return the SDK objects listed above.

{
  "items": [
    {
      "id": "123456",
      "title": "Apple Q2",
      "summary": "Earnings beat",
      "pubTimestamp": 1729413600,
      "url": "https://example.com/news/123456"
    }
  ],
  "pageCount": 1,
  "pageSize": 20,
  "totalPage": 1,
  "totalSize": 1
}

Request rate

Base limit: 60 requests/minute.