Skip to content

Latest commit

 

History

History
97 lines (74 loc) · 10.7 KB

market-news-client-api-mapping.md

File metadata and controls

97 lines (74 loc) · 10.7 KB

Market News Client API Mapping

Yahoo Finance News API Example

Sequence Diagram

market-news-integration-api-Market News Integration.svg

GET /client-api/v1/news/feeds/{feedId}

Yahoo Finance API:

https://query1.finance.yahoo.com/v11/finance/quoteSummary/aapl?modules=financialData

Request Mapping

BB Field News Field Description
feedId q String News feed

Response Mapping

BB Field News Field Description
title###### REQUIRED
    | `news.title`                    | StringNews title first 50 character                                                                                                                                                            |

| text###### REQUIRED | news.title | String | | link###### REQUIRED | news.link | StringLink to the full article | | publishDate | providerPublishTime | DateTimePublication date of the article | | tickers[].name | relatedTickers | array[news_entry_tickers]Tickers of the related investment instruments | | tickers[].performanceChange | - | Skip | | source | publisher | StringName of the news source | | media.contentType | Constant: image/jpeg | news_entry_media | | media.url | thumbnail.resolutions.url | if tag == original |

BB Field News Field Description
id###### REQUIRED
Constant: [Latest News, World News] StringThe identifier of a news feed
name###### REQUIRED
Constant: [Latest News, World News] StringThe name of the news feed

Request Mapping

BB Field News Field Description
#### ticker
| `q`            | String News query |

| #### from | * | | | #### size | * | |

Response Mapping

BB Field News Field Description
title###### REQUIRED
    | `news.title`                    | StringNews title first 50 character                                                                                                                                                            |

| text###### REQUIRED | news.title | String | | link###### REQUIRED | news.link | StringLink to the full article | | publishDate | providerPublishTime | DateTimePublication date of the article | | tickers[].name | relatedTickers | array[news_entry_tickers]Tickers of the related investment instruments | | tickers[].performanceChange | - | Skip | | source | publisher | StringName of the news source | | media.contentType | Constant: image/jpeg | news_entry_media | | media.url | thumbnail.resolutions.url | if tag == original |

BB Field News Field Description
title###### REQUIRED
    | `news.title`                    | StringNews title first 50 character                                                                                                                                                            |

| text###### REQUIRED | news.title | String | | link###### REQUIRED | news.link | StringLink to the full article | | publishDate | providerPublishTime | DateTimePublication date of the article | | tickers[].name | relatedTickers | array[news_entry_tickers]Tickers of the related investment instruments | | tickers[].performanceChange | - | Skip | | source | publisher | StringName of the news source | | media.contentType | Constant: image/jpeg | news_entry_media | | media.url | thumbnail.resolutions.url | if tag == original |