openapi: 3.0.1 info: title: APIs.io Engineering Platform News Search Client description: "The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web)." contact: {} version: "1.0" x-apisguru-categories: - developer_tools - cloud x-logo: url: https://twitter.com/microsoft/profile_image?size=original x-origin: - format: swagger url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json version: "2.0" x-providerName: microsoft.com x-serviceName: cognitiveservices-NewsSearch x-tags: - Microsoft servers: - url: https://api.cognitive.microsoft.com/bing/v7.0 security: - apiKeyHeader: [] paths: /news: get: tags: - NewsCategory summary: "APIs.io Engineering Platform The News Category API lets you search on Bing and get back a list of top news articles by category. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web)." operationId: News_Category parameters: - name: X-BingApis-SDK in: header description: Activate swagger compliance required: true schema: type: string enum: - "true" x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method - name: Accept in: header description: "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json." schema: type: string - name: Accept-Language in: header description: "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language." schema: type: string x-ms-client-name: AcceptLanguage x-ms-client-name: AcceptLanguage - name: User-Agent in: header description: "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53" schema: type: string x-ms-client-name: UserAgent x-ms-client-name: UserAgent - name: X-MSEdge-ClientID in: header description: "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request." schema: type: string x-ms-client-name: ClientId x-ms-client-name: ClientId - name: X-MSEdge-ClientIP in: header description: "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results." schema: type: string x-ms-client-name: ClientIp x-ms-client-name: ClientIp - name: X-Search-Location in: header description: "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header." schema: type: string x-ms-client-name: Location x-ms-client-name: Location - name: cc in: query description: "A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do not specify both." schema: type: string x-ms-client-name: CountryCode x-ms-client-name: CountryCode - name: category in: query description: "The category of articles to return. For example, Sports articles or Entertainment articles. For a list of possible categories, see [News Categories by Market](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#categories-by-market). Use this parameter only with News Category API. If you do not specify this parameter, the response includes both: Headline articles typically published in the last 24 hours from any category and articles from each parent category (up to four articles). If the article is a headline, the article's headline field is set to true. By default, the response includes up to 12 headline articles. To specify the number of headline articles to return, set the [headlineCount](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#headlineCount) query parameter." schema: type: string x-ms-client-name: Category x-ms-client-name: Category - name: count in: query description: "The number of news articles to return in the response. The actual number delivered may be less than requested. The default is 10 and the maximum value is 100. The actual number delivered may be less than requested.You may use this parameter along with the offset parameter to page results. For example, if your user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results. If you do not specify the [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) parameter, Bing ignores this parameter." schema: type: integer format: int32 x-ms-client-name: Count x-ms-client-name: Count - name: headlineCount in: query description: "The number of headline articles to return in the response. The default is 12. Specify this parameter only if you do not specify the [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) parameter." schema: type: integer format: int32 x-ms-client-name: HeadlineCount x-ms-client-name: HeadlineCount - name: mkt in: query description: "The market where the results come from. Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes). NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes), Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both." schema: type: string x-ms-client-name: Market x-ms-client-name: Market - name: offset in: query description: "The zero-based offset that indicates the number of news to skip before returning news. The default is 0. The offset should be less than ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches) - count). Use this parameter along with the count parameter to page results. For example, if your user interface displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results. If you do not specify the [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) parameter, Bing ignores this parameter." schema: type: integer format: int32 x-ms-client-name: Offset x-ms-client-name: Offset - name: originalImg in: query description: "A Boolean value that determines whether the image's contentUrl contains a URL that points to a thumbnail of the original article's image or the image itself. If the article includes an image, and this parameter is set to true, the image's contentUrl property contains a URL that you may use to download the original image from the publisher's website. Otherwise, if this parameter is false, the image's contentUrl and thumbnailUrl URLs both point to the same thumbnail image. Use this parameter only with the News Search API or News Category API. Trending Topics API ignore this parameter." schema: type: boolean x-ms-client-name: OriginalImage x-ms-client-name: OriginalImage - name: safeSearch in: query description: "Filter news for adult content. The following are the possible filter values. Off: Return news articles with adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content." schema: type: string enum: - "false" - Moderate - Strict x-ms-client-name: SafeSearch x-ms-enum: modelAsString: true name: SafeSearch x-ms-client-name: SafeSearch x-ms-enum: modelAsString: true name: SafeSearch - name: setLang in: query description: "The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage) header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language." schema: type: string x-ms-client-name: SetLang x-ms-client-name: SetLang - name: textDecorations in: query description: "A Boolean value that determines whether display strings contain decoration markers such as hit highlighting characters. If true, the strings may include markers. The default is false. To specify whether to use Unicode characters or HTML tags as the markers, see the [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat) query parameter. For information about hit highlighting, see [Hit Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting)." schema: type: boolean x-ms-client-name: TextDecorations x-ms-client-name: TextDecorations - name: textFormat in: query description: "The type of markers to use for text decorations (see the textDecorations query parameter). Possible values are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use tags to highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for example, < is escaped to <)." schema: type: string enum: - Raw - Html x-ms-client-name: TextFormat x-ms-enum: modelAsString: true name: TextFormat x-ms-client-name: TextFormat x-ms-enum: modelAsString: true name: TextFormat responses: "200": description: Success. content: application/json: schema: $ref: '#/components/schemas/News' default: description: An error has occurred. Check the response type and/or status code for more details. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-ms-examples: Successful query: parameters: Accept: application/json Accept-language: en-us Ocp-Apim-Subscription-Key: "{API key}" User-Agent: "{User Agent}" X-BingApis-SDK: "true" X-MS-EdgeClientIP: "{IP AddresS}" X-MSEdge-ClientID: "{Client ID}" category: sports cc: US mkt: en-us setLang: en responses: "200": body: _type: News value: - _type: NewsArticle category: Sports datePublished: 2017-11-17T07:19:00Z description: "The sixth question on the same subject pushed Fred Hoiberg over the edge. “Guys, I’m going to try to get our guys ready to play a game,” the Bulls coach said Tuesday. Until Nikola Mirotic speaks to Bobby Portis — or at least to reporters to ..." image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.372546C0684230BBFABBE735B0D85E0E&pid=News height: 393 width: 700 name: '''It’s a very difficult situation:'' Bulls try to focus as Nikola Mirotic-Bobby Portis drama continues' provider: - _type: Organization image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.SIR111219528389e4ac0552cd50a9f07f86e23462e7&pid=News name: Chicago Tribune url: http://www.chicagotribune.com/sports/basketball/bulls/ct-spt-bulls-nikola-mirotic-bobby-portis-fallout-20171115-story.html - _type: NewsArticle category: Sports datePublished: 2017-11-16T19:15:00Z description: "The ratings for NBC’s Sunday Night Football broadcasts are down 8 percent compared to last year. And while there are several explanations for the decline (i.e. cord cutting), NFL player protests of racial injustice during the national anthem continue to ..." image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.C88D0D1DA5DB60A88B6E2062EC498ACE&pid=News height: 393 width: 700 name: "Al Michaels: Player protests and Donald Trump contributed to NFL ratings decline" provider: - _type: Organization image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.SIR111219423d8564095bc699fb54aa46bd19819288&pid=News name: USA Today Sports For The Win url: http://ftw.usatoday.com/2017/11/al-michaels-nbc-nfl-ratings-sunday-night-football-player-protests-donald-trump-decline - _type: NewsArticle category: Sports datePublished: 2017-11-17T00:35:00Z description: "Dallas Cowboys owner Jerry Jones has asked for a special league meeting with NFL owners to talk about commissioner Roger Goodell's contract extension negotiations, but an ownership source told ESPN's Jim Trotter that owners currently have no plans to act ..." image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.0D5611D738B0DE113E9EE80CC2A26BDD&pid=News height: 324 width: 576 name: "Source: Owners don't plan to act on Jerry Jones' sit-down request" provider: - _type: Organization image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.SIR11122011f8b32789f686c3f36f3ef26bff413db4&pid=News name: ABC News url: http://abcnews.go.com/Sports/source-owners-plan-act-jerry-jones-sit-request/story?id=51210517 webSearchUrl: https://www.bing.com/news/search?q=sports+news&form=TNSA02 headers: {} /news/search: get: tags: - NewsSearch summary: "APIs.io Engineering Platform The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web)." operationId: News_Search parameters: - name: X-BingApis-SDK in: header description: Activate swagger compliance required: true schema: type: string enum: - "true" x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method - name: Accept in: header description: "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json." schema: type: string - name: Accept-Language in: header description: "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language." schema: type: string x-ms-client-name: AcceptLanguage x-ms-client-name: AcceptLanguage - name: User-Agent in: header description: "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53" schema: type: string x-ms-client-name: UserAgent x-ms-client-name: UserAgent - name: X-MSEdge-ClientID in: header description: "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request." schema: type: string x-ms-client-name: ClientId x-ms-client-name: ClientId - name: X-MSEdge-ClientIP in: header description: "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results." schema: type: string x-ms-client-name: ClientIp x-ms-client-name: ClientIp - name: X-Search-Location in: header description: "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header." schema: type: string x-ms-client-name: Location x-ms-client-name: Location - name: cc in: query description: "A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do not specify both." schema: type: string x-ms-client-name: CountryCode x-ms-client-name: CountryCode - name: count in: query description: "The number of news articles to return in the response. The actual number delivered may be less than requested. The default is 10 and the maximum value is 100. The actual number delivered may be less than requested.You may use this parameter along with the offset parameter to page results. For example, if your user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results." schema: type: integer format: int32 x-ms-client-name: Count x-ms-client-name: Count - name: freshness in: query description: "Filter news by the date and time that Bing discovered the news. The following are the possible filter values. Day: Return news discovered within the last 24 hours. Week: Return news discovered within the last 7 days. Month: Return news discovered within the last 30 days. Use this parameter only with the News Search API. Do not specify this parameter when calling the News Category API or the Trending Topics API." schema: type: string enum: - Day - Week - Month x-ms-client-name: Freshness x-ms-enum: modelAsString: true name: Freshness x-ms-client-name: Freshness x-ms-enum: modelAsString: true name: Freshness - name: mkt in: query description: "The market where the results come from. Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes). NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes), Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both." schema: type: string x-ms-client-name: Market x-ms-client-name: Market - name: offset in: query description: "The zero-based offset that indicates the number of news to skip before returning news. The default is 0. The offset should be less than ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches) - count). Use this parameter along with the count parameter to page results. For example, if your user interface displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results." schema: type: integer format: int32 x-ms-client-name: Offset x-ms-client-name: Offset - name: originalImg in: query description: "A Boolean value that determines whether the image's contentUrl contains a URL that points to a thumbnail of the original article's image or the image itself. If the article includes an image, and this parameter is set to true, the image's contentUrl property contains a URL that you may use to download the original image from the publisher's website. Otherwise, if this parameter is false, the image's contentUrl and thumbnailUrl URLs both point to the same thumbnail image. Use this parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API or News Category API." schema: type: boolean x-ms-client-name: OriginalImage x-ms-client-name: OriginalImage - name: q in: query description: "The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API or News Category API." required: true schema: type: string x-ms-client-name: Query x-ms-client-name: Query - name: safeSearch in: query description: "Filter news for adult content. The following are the possible filter values. Off: Return news articles with adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content." schema: type: string enum: - "false" - Moderate - Strict x-ms-client-name: SafeSearch x-ms-enum: modelAsString: true name: SafeSearch x-ms-client-name: SafeSearch x-ms-enum: modelAsString: true name: SafeSearch - name: setLang in: query description: "The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage) header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language." schema: type: string x-ms-client-name: SetLang x-ms-client-name: SetLang - name: sortBy in: query description: "The order to return the news in. The following are the possible case-insensitive values. Date: If the request is through the News Search API, the response returns news articles sorted by date from the most recent to the oldest. If the request is through the News Trending Topics API, the response returns trending topics sorted by date from the most recent to the oldest." schema: type: string x-ms-client-name: SortBy x-ms-client-name: SortBy - name: textDecorations in: query description: "A Boolean value that determines whether display strings contain decoration markers such as hit highlighting characters. If true, the strings may include markers. The default is false. To specify whether to use Unicode characters or HTML tags as the markers, see the [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat) query parameter. For information about hit highlighting, see [Hit Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting)." schema: type: boolean x-ms-client-name: TextDecorations x-ms-client-name: TextDecorations - name: textFormat in: query description: "The type of markers to use for text decorations (see the textDecorations query parameter). Possible values are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use tags to highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for example, < is escaped to <)." schema: type: string enum: - Raw - Html x-ms-client-name: TextFormat x-ms-enum: modelAsString: true name: TextFormat x-ms-client-name: TextFormat x-ms-enum: modelAsString: true name: TextFormat responses: "200": description: Success. content: application/json: schema: $ref: '#/components/schemas/News' default: description: An error has occurred. Check the response type and/or status code for more details. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-ms-examples: Successful query: parameters: Accept: application/json Accept-language: en-us Ocp-Apim-Subscription-Key: "{API key}" User-Agent: "{User Agent}" X-BingApis-SDK: "true" X-MS-EdgeClientIP: "{IP AddresS}" X-MSEdge-ClientID: "{Client ID}" cc: US mkt: en-us q: microsoft setLang: en responses: "200": body: _type: News totalEstimatedMatches: 46 value: - _type: NewsArticle category: ScienceAndTechnology datePublished: 2017-11-16T14:15:00Z description: "Don't call it Surface Pro 5. The latest iteration of the Surface Pro loses the model number, keeps the kickstand, and adds mostly subtle refinements. Read More For the past five days, I've been using a Surface Book 2 in place of my everyday PC, a first ..." name: "Surface Book 2 (15-inch): Microsoft supersizes its most powerful portable PC" provider: - _type: Organization name: ZDNet url: http://www.zdnet.com/product/microsoft-surface-book-2/ - _type: NewsArticle category: ScienceAndTechnology datePublished: 2017-11-17T06:13:00Z description: "Microsoft Surface Book 2 - 15" - Core i7 8650U - 16 GB RAM - 512 GB SSD - English - North America fux00001 $2,899.00 Microsoft Surface Book 2 - 15" - Core i7 8650U - 16 GB RAM - 256 GB SSD - English - North America hnr00001 $2,499.00 Microsoft Surface Book ..." image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.4A5C3F257DA120C0D7778A4A764A0292&pid=News height: 393 width: 700 name: 'Microsoft Surface Book 2 (15-inch) review:' provider: - _type: Organization name: CNET url: https://www.cnet.com/products/microsoft-surface-book-2/review/ video: _type: VideoObject allowHttpsEmbed: true name: Microsoft Surface Book 2 (15-inch) thumbnail: _type: ImageObject height: 269 width: 480 thumbnailUrl: https://www.bing.com/th?id=ON.C362047C8A293C48E4DBF9FCF1C99DD2&pid=News - _type: NewsArticle category: ScienceAndTechnology datePublished: 2017-11-17T04:27:00Z description: "At just two years old, Edge is the new kid on the web browser block, but what it lacks in maturity, it makes up for in speed and convenience. Development has been swift. With each major Windows 10 release, Edge improves. Windows 10 Fall Creators Update ..." image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.D6CC6169ECD49465AACCC1327B37283E&pid=News height: 394 width: 700 name: "12 Reasons Microsoft's Edge Browser Rocks (No, Really)" provider: - _type: Organization name: PC Magazine url: https://www.pcmag.com/feature/357262/12-reasons-microsoft-s-edge-browser-rocks-no-really - _type: NewsArticle category: ScienceAndTechnology clusteredArticles: - _type: NewsArticle category: ScienceAndTechnology datePublished: 2017-11-17T01:59:00Z description: "It may have been the company's first-ever laptop, but when I tested it last year a few months after it debuted, I immediately liked it better than any of Apple's MacBooks that I'd ever used. I now have a new favorite computer, and it's the successor to my ..." name: "REVIEW: Microsoft's newest laptop is my new favorite computer (MSFT)" provider: - _type: Organization name: Business Insider on MSN.com url: https://www.msn.com/en-us/money/other/review-microsofts-newest-laptop-is-my-new-favorite-computer-msft/ar-BBF2svf datePublished: 2017-11-16T23:58:00Z description: "Microsoft's original Surface Book was my favorite computer. It may have been the company's first-ever laptop, but when I tested it last year a few months after it debuted, I immediately liked it better than any of Apple's MacBooks that I'd ever used." image: _type: ImageObject thumbnail: _type: ImageObject contentUrl: https://www.bing.com/th?id=ON.7CEEFC996C222EA79BC65ABFE9356D63&pid=News height: 524 width: 700 name: "REVIEW: Microsoft's newest laptop is a powerful alternative to any of Apple's MacBooks or iPads" provider: - _type: Organization name: Business Insider url: http://www.businessinsider.com/microsoft-surface-book-2-review-2017-11 headers: {} /news/trendingtopics: get: tags: - NewsTrendingTopics summary: "APIs.io Engineering Platform The News Trending Topics API lets you search on Bing and get back a list of trending news topics that are currently trending on Bing. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web)." operationId: News_Trending parameters: - name: X-BingApis-SDK in: header description: Activate swagger compliance required: true schema: type: string enum: - "true" x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method - name: Accept in: header description: "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json." schema: type: string - name: Accept-Language in: header description: "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language." schema: type: string x-ms-client-name: AcceptLanguage x-ms-client-name: AcceptLanguage - name: User-Agent in: header description: "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53" schema: type: string x-ms-client-name: UserAgent x-ms-client-name: UserAgent - name: X-MSEdge-ClientID in: header description: "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request." schema: type: string x-ms-client-name: ClientId x-ms-client-name: ClientId - name: X-MSEdge-ClientIP in: header description: "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results." schema: type: string x-ms-client-name: ClientIp x-ms-client-name: ClientIp - name: X-Search-Location in: header description: "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header." schema: type: string x-ms-client-name: Location x-ms-client-name: Location - name: cc in: query description: "A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do not specify both." schema: type: string x-ms-client-name: CountryCode x-ms-client-name: CountryCode - name: count in: query description: "The number of news articles to return in the response. The actual number delivered may be less than requested. The default is 10 and the maximum value is 100. The actual number delivered may be less than requested.You may use this parameter along with the offset parameter to page results. For example, if your user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results." schema: type: integer format: int32 x-ms-client-name: Count x-ms-client-name: Count - name: mkt in: query description: "The market where the results come from. Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes). NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes), Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both." schema: type: string x-ms-client-name: Market x-ms-client-name: Market - name: offset in: query description: "The zero-based offset that indicates the number of news to skip before returning news. The default is 0. The offset should be less than ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches) - count). Use this parameter along with the count parameter to page results. For example, if your user interface displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results." schema: type: integer format: int32 x-ms-client-name: Offset x-ms-client-name: Offset - name: safeSearch in: query description: "Filter news for adult content. The following are the possible filter values. Off: Return news articles with adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content." schema: type: string enum: - "false" - Moderate - Strict x-ms-client-name: SafeSearch x-ms-enum: modelAsString: true name: SafeSearch x-ms-client-name: SafeSearch x-ms-enum: modelAsString: true name: SafeSearch - name: setLang in: query description: "The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage) header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language." schema: type: string x-ms-client-name: SetLang x-ms-client-name: SetLang - name: since in: query description: "The Unix epoch time (Unix timestamp) that Bing uses to select the trending topics. Bing returns trending topics that it discovered on or after the specified date and time, not the date the topic was published. To use this parameter, also specify the sortBy parameter. Use this parameter only with the News Trending Topics API. Do not specify this parameter when calling the News Search API or News Category API." schema: type: integer format: int64 x-ms-client-name: Since x-ms-client-name: Since - name: sortBy in: query description: "The order to return the news in. The following are the possible case-insensitive values. Date: If the request is through the News Search API, the response returns news articles sorted by date from the most recent to the oldest. If the request is through the News Trending Topics API, the response returns trending topics sorted by date from the most recent to the oldest." schema: type: string x-ms-client-name: SortBy x-ms-client-name: SortBy - name: textDecorations in: query description: "A Boolean value that determines whether display strings contain decoration markers such as hit highlighting characters. If true, the strings may include markers. The default is false. To specify whether to use Unicode characters or HTML tags as the markers, see the [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat) query parameter. For information about hit highlighting, see [Hit Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting)." schema: type: boolean x-ms-client-name: TextDecorations x-ms-client-name: TextDecorations - name: textFormat in: query description: "The type of markers to use for text decorations (see the textDecorations query parameter). Possible values are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use tags to highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for example, < is escaped to <)." schema: type: string enum: - Raw - Html x-ms-client-name: TextFormat x-ms-enum: modelAsString: true name: TextFormat x-ms-client-name: TextFormat x-ms-enum: modelAsString: true name: TextFormat responses: "200": description: Success. content: application/json: schema: $ref: '#/components/schemas/TrendingTopics' default: description: An error has occurred. Check the response type and/or status code for more details. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-ms-examples: Successful query: parameters: Accept: application/json Accept-language: en-us Ocp-Apim-Subscription-Key: "{API key}" User-Agent: "{User Agent}" X-BingApis-SDK: "true" X-MS-EdgeClientIP: "{IP AddresS}" X-MSEdge-ClientID: "{Client ID}" cc: US mkt: en-us setLang: en responses: "200": body: _type: TrendingTopics value: - _type: News/Topic image: _type: ImageObject provider: - _type: Organization name: © Leon Neal/AFP/Getty Images url: https://www.bing.com/th?id=OPN.RTNews_ffDPbGlga7auVKMCVRmYdA&c=7&rs=2&qlt=80&pcl=f9f9f9&pid=News isBreakingNews: false name: 1st fatal overdose? newsSearchUrl: https://www.bing.com/news/search?q=First+marijuana+overdose&form=TNSA02&filters=tnTID%3a%22DF2B2270-F7AB-4b6d-B6C2-E6705CAC121F%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%220%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 query: text: First marijuana overdose webSearchUrl: https://www.bing.com/search?q=First+marijuana+overdose&form=TNSA01&filters=tnTID%3a%22DF2B2270-F7AB-4b6d-B6C2-E6705CAC121F%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%220%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 - _type: News/Topic image: _type: ImageObject provider: - _type: Organization name: © Ilya S. Savenok/FEHSF/Getty Images url: https://www.bing.com/th?id=OPN.RTNews_gDx8xMp4ozOfAPvxuddEdw&c=7&rs=2&qlt=80&pcl=f9f9f9&pid=News isBreakingNews: false name: Suffers cardiac event newsSearchUrl: https://www.bing.com/news/search?q=Tom+Ridge&form=TNSA02&filters=tnTID%3a%22211EE3BA-A994-4533-864F-D1AA669AADE4%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%221%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 query: text: Tom Ridge webSearchUrl: https://www.bing.com/search?q=Tom+Ridge&form=TNSA01&filters=tnTID%3a%22211EE3BA-A994-4533-864F-D1AA669AADE4%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%221%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 - _type: News/Topic image: _type: ImageObject provider: - _type: Organization name: © AP Photo url: https://www.bing.com/th?id=OPN.RTNews_TY9fYHZVSzGqcqECHNgpyQ&c=7&rs=2&qlt=80&pcl=f9f9f9&pid=News isBreakingNews: false name: Manson still alive newsSearchUrl: https://www.bing.com/news/search?q=Charles+Manson+Bakersfield+still+alive&form=TNSA02&filters=tnTID%3a%22A2638A2E-154F-41d0-A306-6B20062D4494%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%222%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 query: text: Charles Manson Bakersfield still alive webSearchUrl: https://www.bing.com/search?q=Charles+Manson+Bakersfield+still+alive&form=TNSA01&filters=tnTID%3a%22A2638A2E-154F-41d0-A306-6B20062D4494%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%222%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 - _type: News/Topic image: _type: ImageObject provider: - _type: Organization name: © Carlo Allegri/Reuters url: https://www.bing.com/th?id=OPN.RTNews_Vy3FSPV-k2W269NnPf7i5Q&c=7&rs=2&qlt=80&pcl=f9f9f9&pid=News isBreakingNews: false name: Kochs backing sale newsSearchUrl: https://www.bing.com/news/search?q=Koch+Brothers&form=TNSA02&filters=tnTID%3a%22178FD502-59BD-4a17-89D3-49CF96025DF0%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%223%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 query: text: Koch Brothers webSearchUrl: https://www.bing.com/search?q=Koch+Brothers&form=TNSA01&filters=tnTID%3a%22178FD502-59BD-4a17-89D3-49CF96025DF0%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%223%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 - _type: News/Topic image: _type: ImageObject provider: - _type: Organization name: © AP url: https://www.bing.com/th?id=OPN.RTNews_hE_gEJxcXVPPkBRYdra44A&c=7&rs=2&qlt=80&pcl=f9f9f9&pid=News isBreakingNews: false name: Democratic mega-donor newsSearchUrl: https://www.bing.com/news/search?q=Steve+Mostyn&form=TNSA02&filters=tnTID%3a%22B105C6CD-6361-47fc-B063-7C35458B7D41%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%224%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 query: text: Steve Mostyn webSearchUrl: https://www.bing.com/search?q=Steve+Mostyn&form=TNSA01&filters=tnTID%3a%22B105C6CD-6361-47fc-B063-7C35458B7D41%22+tnVersion%3a%222214682%22+Segment%3a%22popularnow.carousel%22+tnCol%3a%224%22+tnScenario%3a%22TrendingTopicsAPI%22+tnOrder%3a%229b3211c9-158e-4564-8899-6f758d123e84%22 headers: {} components: schemas: Answer: properties: followUpQueries: type: array readOnly: true items: $ref: '#/components/schemas/Query' description: Defines an answer. allOf: - $ref: '#/components/schemas/Response' Article: properties: wordCount: type: integer description: The number of words in the text of the Article. format: int32 readOnly: true allOf: - $ref: '#/components/schemas/CreativeWork' CreativeWork: properties: datePublished: type: string description: The date on which the CreativeWork was published. readOnly: true provider: type: array description: The source of the creative work. readOnly: true items: $ref: '#/components/schemas/Thing' thumbnailUrl: type: string description: The URL to a thumbnail of the item. readOnly: true video: $ref: '#/components/schemas/VideoObject' description: "The most generic kind of creative work, including books, movies, photographs, software programs, etc." allOf: - $ref: '#/components/schemas/Thing' Error: required: - code - message type: object properties: code: type: string description: The error code that identifies the category of error. default: None enum: - None - ServerError - InvalidRequest - RateLimitExceeded - InvalidAuthorization - InsufficientAuthorization x-ms-enum: modelAsString: true name: ErrorCode message: type: string description: A description of the error. moreDetails: type: string description: A description that provides additional information about the error. readOnly: true parameter: type: string description: The parameter in the request that caused the error. readOnly: true subCode: type: string description: The error code that further helps to identify the error. readOnly: true enum: - UnexpectedError - ResourceError - NotImplemented - ParameterMissing - ParameterInvalidValue - HttpNotAllowed - Blocked - AuthorizationMissing - AuthorizationRedundancy - AuthorizationDisabled - AuthorizationExpired x-ms-enum: modelAsString: true name: ErrorSubCode value: type: string description: The parameter's value in the request that was not valid. readOnly: true description: Defines the error that occurred. ErrorResponse: required: - errors properties: errors: type: array description: A list of errors that describe the reasons why the request failed. items: $ref: '#/components/schemas/Error' description: The top-level response that represents a failed request. allOf: - $ref: '#/components/schemas/Response' Identifiable: properties: id: type: string description: A String identifier. readOnly: true description: Defines the identity of a resource. allOf: - $ref: '#/components/schemas/ResponseBase' ImageObject: properties: thumbnail: $ref: '#/components/schemas/ImageObject' description: Defines an image allOf: - $ref: '#/components/schemas/MediaObject' MediaObject: properties: contentUrl: type: string description: Original URL to retrieve the source (file) for the media object (e.g the source URL for the image). readOnly: true height: type: integer description: "The height of the source media object, in pixels." format: int32 readOnly: true width: type: integer description: "The width of the source media object, in pixels." format: int32 readOnly: true description: Defines a media object. allOf: - $ref: '#/components/schemas/CreativeWork' News: required: - value properties: location: type: string description: Location of local news readOnly: true value: type: array description: "An array of NewsArticle objects that contain information about news articles that are relevant to the query. If there are no results to return for the request, the array is empty." items: $ref: '#/components/schemas/NewsArticle' description: Defines a news answer. allOf: - $ref: '#/components/schemas/SearchResultsAnswer' NewsArticle: properties: category: type: string description: "The news category that the article belongs to. For example, Sports. If the news category cannot be determined, the article does not include this field." readOnly: true clusteredArticles: type: array description: A list of related news articles. readOnly: true items: $ref: '#/components/schemas/NewsArticle' headline: type: boolean description: "A Boolean value that indicates whether the news article is a headline. If true, the article is a headline. The article includes this field only for news categories requests that do not specify the category query parameter." readOnly: true description: Defines a news article. allOf: - $ref: '#/components/schemas/Article' NewsTopic: properties: isBreakingNews: type: boolean description: "A Boolean value that indicates whether the topic is considered breaking news. If the topic is considered breaking news, the value is true." readOnly: true newsSearchUrl: type: string description: The URL to the Bing News search results for the search query term readOnly: true query: $ref: '#/components/schemas/Query' allOf: - $ref: '#/components/schemas/Thing' x-ms-discriminator-value: News/Topic Organization: description: Defines an organization. allOf: - $ref: '#/components/schemas/Thing' Query: required: - text type: object properties: displayText: type: string description: The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting readOnly: true searchLink: type: string description: "The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL." readOnly: true text: type: string description: The query string. Use this string as the query term in a new search request. thumbnail: $ref: '#/components/schemas/ImageObject' webSearchUrl: type: string description: The URL that takes the user to the Bing search results page for the query.Only related search results include this field. readOnly: true description: Defines a search query. Response: properties: webSearchUrl: type: string description: The URL To Bing's search result for this item. readOnly: true description: Defines a response. All schemas that could be returned at the root of a response should inherit from this allOf: - $ref: '#/components/schemas/Identifiable' ResponseBase: required: - _type type: object properties: _type: type: string description: Response base discriminator: propertyName: _type SearchResultsAnswer: properties: totalEstimatedMatches: type: integer description: The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results. format: int64 readOnly: true description: Defines a search result answer. allOf: - $ref: '#/components/schemas/Answer' Thing: properties: alternateName: type: string description: An alias for the item readOnly: true bingId: type: string description: An ID that uniquely identifies this item. readOnly: true description: type: string description: A short description of the item. readOnly: true image: $ref: '#/components/schemas/ImageObject' name: type: string description: The name of the thing represented by this object. readOnly: true url: type: string description: The URL to get more information about the thing represented by this object. readOnly: true description: Defines a thing. allOf: - $ref: '#/components/schemas/Response' TrendingTopics: required: - value properties: value: type: array description: A list of trending news topics on Bing items: $ref: '#/components/schemas/NewsTopic' allOf: - $ref: '#/components/schemas/Answer' VideoObject: properties: allowHttpsEmbed: type: boolean readOnly: true allowMobileEmbed: type: boolean readOnly: true embedHtml: type: string readOnly: true isSuperfresh: type: boolean readOnly: true motionThumbnailId: type: string readOnly: true motionThumbnailUrl: type: string readOnly: true thumbnail: $ref: '#/components/schemas/ImageObject' videoId: type: string readOnly: true viewCount: type: integer format: int32 readOnly: true description: Defines a video object that is relevant to the query. allOf: - $ref: '#/components/schemas/MediaObject' parameters: x-bingapis-sdk: name: X-BingApis-SDK in: header description: Activate swagger compliance required: true schema: type: string enum: - "true" x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method x-ms-enum: modelAsString: true name: XBingApisSDK x-ms-parameter-location: method securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header x-ms-parameterized-host: hostTemplate: "{Endpoint}" parameters: - default: https://api.cognitive.microsoft.com description: "Supported Cognitive Services endpoints (protocol and hostname, for example: \"https://westus.api.cognitive.microsoft.com\", \"https://api.cognitive.microsoft.com\")." x-ms-parameter-location: client x-ms-skip-url-encoding: true useSchemePrefix: false x-original-swagger-version: "2.0" tags: - name: NewsCategory - name: NewsSearch - name: NewsTrendingTopics