Source: https://eventregistry.org/documentation?tab=articleDetails # Get article details Obtain details about a single or multiple news articles. Use this endpoint if you have a list of article URIs and want to obtain article details with all available meta-information. In each call, you can provide up to 100 article URIs. The cost of the action is the same as the cost of the article search. Article URIs can be obtained using different endpoints, such as using [Get Articles](/documentation?tab=searchArticles) endpoint, where the `resultType` is set to `uriWgtList`. **Endpoint:** GET | POST `https://eventregistry.org/api/v1/article/getArticle` **Headers:** Content-Type: application/json #### `Parameters` #### `apiKey` string (required) Your API key #### `articleUri` string | string[] (required) Articles are identifiable by their unique IDs (called URIs) that are assigned by Event Registry. Provide URI or a set of up to 100 URIs. #### `resultType` string Define what kind of results you would like to get. Available values: `info`, `duplicatedArticles`, `originalArticle` Default value: `info` #### `infoArticleBodyLen` integer Set the size of the article body that'll be returned in the response. Use -1 for full article body. Default value: `-1` #### `Returned Details` The API call can return more or less meta-data information about the articles, concepts, categories, sources and locations. Click to see the available properties that can be specified to determine the amount of returned information. #### `includeArticleTitle` boolean Set this parameter to true to include the article title in the response. Default value: `true` #### `includeArticleBasicInfo` boolean Set this parameter to true to include the core article information in the response. Default value: `true` #### `includeArticleBody` boolean Set this parameter to true to include the article body in the response. Default value: `true` #### `includeArticleEventUri` boolean Set this parameter to true to include the uri of the event (to which the article belongs) in the response. Default value: `true` #### `includeArticleSocialScore` boolean Set this parameter to true to include the information about how many times the article was shared on different social media. Default value: `false` #### `includeArticleSentiment` boolean Set this parameter to true to include the article sentiment in the response (value will be non-null only for English articles). Default value: `true` #### `includeArticleConcepts` boolean Set this parameter to true to include the article concepts in the response. Default value: `false` #### `includeArticleCategories` boolean Set this parameter to true to include the article categories in the response. Default value: `false` #### `includeArticleLocation` boolean Set this parameter to true to include the article location in the response. Default value: `false` #### `includeArticleImage` boolean Set this parameter to true to include the article image in the response. Default value: `true` #### `includeArticleAuthors` boolean Set this parameter to true to include the article authors in the response. Default value: `true` #### `includeArticleVideos` boolean Set this parameter to true to include the article videos in the response. Default value: `false` #### `includeArticleLinks` boolean Set this parameter to true to include the article links in the response. Default value: `false` #### `includeArticleExtractedDates` boolean Set this parameter to true to include article extracted dates in the response. Default value: `false` #### `includeArticleDuplicateList` boolean Set this parameter to true to include the list of duplicate articles in the response. Default value: `false` #### `includeArticleOriginalArticle` boolean Set this parameter to true to include the original article in the response. Default value: `false` #### `includeConceptLabel` boolean Set this parameter to true to include the concept label in the response. Default value: `true` #### `includeConceptImage` boolean Set this parameter to true to include the concept image in the response. Default value: `false` #### `includeConceptSynonyms` boolean Set this parameter to true to include the concept synonyms in the response. Default value: `false` #### `conceptLang` string Define the language of the concept label. Default value: `eng` #### `includeSourceTitle` boolean Set this parameter to true to include the source title in the response. Default value: `true` #### `includeSourceDescription` boolean Set this parameter to true to include the source description in the response. Default value: `false` #### `includeSourceLocation` boolean Set this parameter to true to include the source location in the response. Default value: `false` #### `includeSourceRanking` boolean Set this parameter to true to include the source ranking in the response. Default value: `false` #### `includeLocationPopulation` boolean Set to true to include the population size of the location. Default value: `false` #### `includeLocationGeoNamesId` boolean Set to true to include the GeoNames id of the location. Default value: `false` #### `includeLocationCountryArea` boolean Set to true to include the are of the location in squared km. Default value: `false` #### `includeLocationCountryContinent` boolean Set to true to get the continent of the country for location objects. Default value: `false` ## Request examples ### Example 1 Retrieve information about article with URI 247634888. Request body: ```json { "action": "getArticle", "articleUri": "247634888", "infoArticleBodyLen": -1, "resultType": "info", "apiKey": "YOUR_API_KEY" } ``` ```python from eventregistry import * er = EventRegistry(apiKey = YOUR_API_KEY) q = QueryArticle("247634888") res = er.execQuery(q) ``` ```javascript var er = new erBase.EventRegistry({allowUseOfArchive: false}); const q1 = new erBase.QueryArticle("247634888"); er.execQuery(q1).then((response) => { console.info(response); }); ``` ```typescript const er = new EventRegistry(); const q1 = new QueryArticle("247634888"); er.execQuery(q1).then((response) => { console.info(response); }); ``` ### Example 2 Retrieve article details about a list of article URIs. Request body: ```json { "action": "getArticle", "articleUri": [ "936059390", "936055095", "936053756", "936053919", "935220287" ], "infoArticleBodyLen": -1, "includeArticleConcepts": true, "includeArticleCategories": true, "includeArticleLocation": true, "resultType": "info", "apiKey": "YOUR_API_KEY" } ``` ```python from eventregistry import * er = EventRegistry(apiKey = YOUR_API_KEY) q = QueryArticle(["936059390", "936055095", "936053756", "936053919", "935220287"]) q.setRequestedResult(RequestArticleInfo(returnInfo = ReturnInfo(articleInfo = ArticleInfoFlags(concepts = True, categories = True, location = True)))) res = er.execQuery(q) ``` ```javascript const er = new erBase.EventRegistry(); const articleInfo = new erBase.ArticleInfoFlags({ concepts: true, categories: true, location: true }); const returnInfo = new ReturnInfo({articleInfo}); const q1 = new erBase.QueryArticles([ "936059390", "936055095", "936053756", "936053919", "935220287" ]); q1.setRequestedResult(new erBase.RequestArticleInfo(returnInfo)); er.execQuery(q1).then((response) => { console.info(response); }); ``` ```typescript const er = new EventRegistry(); const articleInfo = new ArticleInfoFlags({ concepts: true, categories: true, location: true }); const returnInfo = new ReturnInfo({articleInfo}); const q1 = new QueryArticles([ "936059390", "936055095", "936053756", "936053919", "935220287" ]); q1.setRequestedResult(new RequestArticleInfo(returnInfo)); er.execQuery(q1).then((response) => { console.info(response); }); ``` ## Example output ```json { "7541106672": { "info": { "uri": "7541106672", "lang": "eng", "isDuplicate": false, "date": "2023-05-12", "time": "13:18:00", "dateTime": "2023-05-12T13:18:00Z", "dateTimePub": "2023-05-12T13:18:00Z", "dataType": "news", "sim": 0.658823549747467, "url": "https://hbr.org/2023/05/yes-the-metaverse-is-still-happening", "title": "Yes, the Metaverse Is Still Happening", "body": "There's still much hype around the metaverse. (trimmed) ...", "source": { "uri": "hbr.org", "dataType": "news", "title": "Hbr" }, "authors": [], "concepts": [ { "uri": "http://en.wikipedia.org/wiki/Sandbox_game", "type": "wiki", "score": 5, "label": { "eng": "Sandbox game" } }, { "uri": "http://en.wikipedia.org/wiki/Digital_twin", "type": "wiki", "score": 5, "label": { "eng": "Digital twin" } }, { "uri": "http://en.wikipedia.org/wiki/Roblox", "type": "wiki", "score": 5, "label": { "eng": "Roblox" } }, { "#META ITEM": "other concepts..." } ], "categories": [ { "uri": "dmoz/Society/Work", "label": "dmoz/Society/Work", "wgt": 100 }, { "uri": "dmoz/Shopping/Health/Disabilities", "label": "dmoz/Shopping/Health/Disabilities", "wgt": 100 }, { "uri": "news/Technology", "label": "news/Technology", "wgt": 91 } ], "image": "https://hbr.org/resources/images/article_assets/2023/04/May23_12_-3183187.jpg", "duplicateList": [], "originalArticle": null, "eventUri": "eng-8615403", "location": null, "extractedDates": null, "shares": { "facebook": 772 }, "sentiment": 0.1764705882352942 } } } ``` ## Output schema ```json { "type": "object", "properties": { "uri": { "type": "object", "properties": { "info": { "type": "object", "properties": { "uri": { "type": "string" }, "lang": { "type": "string" }, "isDuplicate": { "type": "boolean" }, "date": { "type": "string" }, "time": { "type": "string" }, "dateTime": { "type": "string" }, "sim": { "type": "double" }, "url": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "source": { "type": "object", "properties": { "uri": { "type": "string" }, "dataType": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } }, "locationValidated": { "type": "boolean" }, "ranking": { "type": "object", "properties": { "importanceRank": { "type": "integer" } } } } }, "concepts": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "type": { "type": "string" }, "score": { "type": "integer" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } }, "image": { "type": "string" }, "synonyms": { "type": "object", "properties": {} }, "trendingScore": { "type": "object", "properties": { "news": { "type": "object", "properties": { "score": { "type": "double" }, "testPopFq": { "type": "integer" }, "nullPopFq": { "type": "integer" } } } } }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "label": { "type": "string" }, "wgt": { "type": "integer" } } } }, "links": { "type": "array", "items": { "type": "string" } }, "videos": { "type": "array", "items": { "type": "string" } }, "image": { "type": "string" }, "duplicateList": { "type": "array", "items": { "type": "string" } }, "originalArticle": { "type": "string" }, "eventUri": { "type": "string" }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } }, "extractedDates": { "type": "array", "items": { "type": "object", "properties": { "amb": { "type": "boolean" }, "imp": { "type": "boolean" }, "date": { "type": "string" }, "textStart": { "type": "integer" }, "textEnd": { "type": "integer" } } } }, "shares": { "type": "object", "properties": { "facebook": { "type": "integer" } } }, "wgt": { "type": "integer" } } }, "duplicatedArticles": { "type": "object", "properties": { "totalResults": { "type": "integer" }, "page": { "type": "integer" }, "count": { "type": "integer" }, "pages": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "lang": { "type": "string" }, "isDuplicate": { "type": "boolean" }, "date": { "type": "string" }, "time": { "type": "string" }, "dateTime": { "type": "string" }, "sim": { "type": "double" }, "url": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "source": { "type": "object", "properties": { "uri": { "type": "string" }, "dataType": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } }, "locationValidated": { "type": "boolean" }, "ranking": { "type": "object", "properties": { "importanceRank": { "type": "integer" } } } } }, "concepts": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "type": { "type": "string" }, "score": { "type": "integer" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } }, "image": { "type": "string" }, "synonyms": { "type": "object", "properties": {} }, "trendingScore": { "type": "object", "properties": { "news": { "type": "object", "properties": { "score": { "type": "double" }, "testPopFq": { "type": "integer" }, "nullPopFq": { "type": "integer" } } } } }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "label": { "type": "string" }, "wgt": { "type": "integer" } } } }, "links": { "type": "array", "items": { "type": "string" } }, "videos": { "type": "array", "items": { "type": "string" } }, "image": { "type": "string" }, "duplicateList": { "type": "array", "items": { "type": "string" } }, "originalArticle": { "type": "string" }, "eventUri": { "type": "string" }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } }, "extractedDates": { "type": "array", "items": { "type": "object", "properties": { "amb": { "type": "boolean" }, "imp": { "type": "boolean" }, "date": { "type": "string" }, "textStart": { "type": "integer" }, "textEnd": { "type": "integer" } } } }, "shares": { "type": "object", "properties": { "facebook": { "type": "integer" } } }, "wgt": { "type": "integer" } } } } } }, "originalArticle": { "type": "object", "properties": { "uri": { "type": "string" }, "lang": { "type": "string" }, "isDuplicate": { "type": "boolean" }, "date": { "type": "string" }, "time": { "type": "string" }, "dateTime": { "type": "string" }, "sim": { "type": "double" }, "url": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "source": { "type": "object", "properties": { "uri": { "type": "string" }, "dataType": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } }, "locationValidated": { "type": "boolean" }, "ranking": { "type": "object", "properties": { "importanceRank": { "type": "integer" } } } } }, "concepts": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "type": { "type": "string" }, "score": { "type": "integer" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } }, "image": { "type": "string" }, "synonyms": { "type": "object", "properties": {} }, "trendingScore": { "type": "object", "properties": { "news": { "type": "object", "properties": { "score": { "type": "double" }, "testPopFq": { "type": "integer" }, "nullPopFq": { "type": "integer" } } } } }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "label": { "type": "string" }, "wgt": { "type": "integer" } } } }, "links": { "type": "array", "items": { "type": "string" } }, "videos": { "type": "array", "items": { "type": "string" } }, "image": { "type": "string" }, "duplicateList": { "type": "array", "items": { "type": "string" } }, "originalArticle": { "type": "string" }, "eventUri": { "type": "string" }, "location": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "object", "properties": { "eng": { "type": "string" } } } } }, "extractedDates": { "type": "array", "items": { "type": "object", "properties": { "amb": { "type": "boolean" }, "imp": { "type": "boolean" }, "date": { "type": "string" }, "textStart": { "type": "integer" }, "textEnd": { "type": "integer" } } } }, "shares": { "type": "object", "properties": { "facebook": { "type": "integer" } } }, "wgt": { "type": "integer" } } } } } } } ```