Newscatcherapi.Net 2.1.0

Newscatcherapi.Net - the C# library for the NewsCatcher News API V2

NewsCatcher is a data-as-a-service startup that has one main goal: to build the largest database of structured news articles published online. In other words, we're like Google for the news part of the web, which you can access as a source of data.

Some useful links:

• How NewsCatcher Works
• GitHub for the Python SDK

This C# SDK is automatically generated by the Konfig:

• API version: 1.0.1
• SDK version: 2.1.0

<a name="frameworks-supported"></a>

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

<a name="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.1 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Newscatcherapi.Net.Api;
using Newscatcherapi.Net.Client;
using Newscatcherapi.Net.Model;

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Newscatcherapi.Net.Api;
using Newscatcherapi.Net.Client;
using Newscatcherapi.Net.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();

            // Configure custom BasePath if desired
            // config.BasePath = "https://api.newscatcherapi.com/v2";

            // Configure API key authorization: api_key
            config.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new LatestHeadlinesApi(config);
            var lang = en;  // string | Specifies the languages of the search. For example: `en`. The only accepted format is [ISO 639-1 — 2](https://en.wikipedia.org/wiki/ISO_639-1) letter code.  (optional) 
            var notLang = "af";  // string | Inverse to the `lang` parameter  (optional) 
            var countries = "countries_example";  // string | Countries where the news publisher is located. **Important**: This parameter is not responsible for the countries mentioned in the news article. One or multiple countries can be used in the search. The only acceptable format is [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) For example, `US,CA,MX` or just `US`  (optional) 
            var notCountries = "notCountries_example";  // string | The inverse of the `countries` parameter.  (optional) 
            var topic = (Topic) "news";  // Topic? | Accepted values: `news`, `sport`, `tech`, `world`, `finance`, `politics`, `business`, `economics`, `entertainment`, `beauty`, `travel`, `music`, `food`, `science`, `gaming` The topic to which you want to restrict the articles of your choice. Not all news articles are assigned with a topic, therefore, we cannot guarantee that 100% of topics talking about technology will be assigned a tech label.  (optional) 
            var sources = "sources_example";  // string | One or more news resources to filter your search. It should be the normal form of the URL, For example: `nytimes.com,theguardian.com`  (optional) 
            var notSources = "notSources_example";  // string | One or more sources to be excluded from the search. Comma-separated list. For example: `nytimes.com,cnn.com,wsj.com`  (optional) 
            var rankedOnly = true;  // bool? | Default: `True` Limit the search only for the sources which are in the top 1 million online websites. Unranked sources are assigned a rank that equals `999999`  (optional) 
            var pageSize = 56;  // int? | `[1:100]` How many articles to return per page.  (optional) 
            var page = 56;  // int? | The number of the page. Use it to scroll through the results. This parameter is used to paginate: scroll through results because one API response cannot return more than 100 articles.  (optional) 

            try
            {
                // Get Latest News Articles
                Model200ResponseLatest result = apiInstance.Get(lang, notLang, countries, notCountries, topic, sources, notSources, rankedOnly, pageSize, page);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling LatestHeadlinesApi.Get: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://api.newscatcherapi.com/v2

<a name="documentation-for-models"></a>

Documentation for Models

• Model.ArticleInner
• Model.ErrorResponse
• Model.ErrorStatus
• Model.Lang
• Model.LatestHeadlines
• Model.LatestHeadlinesUserInput
• Model.Model200Response
• Model.Model200ResponseLatest
• Model.Model200ResponseSources
• Model.PublishDatePrecision
• Model.Search
• Model.SearchIn
• Model.SearchUserInput
• Model.SortBy
• Model.SourcesQuery
• Model.SourcesUserInput
• Model.SuccessStatus
• Model.Topic

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="api_key"></a>

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header