ballerinax/nytimes.newswire Ballerina library

Overview

This is a generated connector for New York Times Newswire API v3.0.0 OpenAPI specification. With the Times Newswire API, you can get links and metadata for Times' articles as soon as they are published on NYTimes.com. The Times Newswire API provides an up-to-the-minute stream of published articles. You can filter results by source (all, nyt, inyt) and section (arts, business, ...).

Prerequisites

Before using this connector in your Ballerina application, complete the following:

• Create NYTimes developer account
• Obtain tokens
  1. Log into NYTimes Developer Portal by visiting https://developer.nytimes.com/accounts/login
  2. Register an app and obtain the API Key following the process summarized here.

Quickstart

To use the New York Times Newswire connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/nytimes.newswire module into the Ballerina project.

import ballerinax/nytimes.newswire as nt;

Step 2: Create a new connector instance

Create a newswire:ApiKeysConfig with the API key obtained, and initialize the connector with it.

nt:ApiKeysConfig config = {
    apiKey: "<API_KEY>"
}
nt:Client baseClient = check new Client(config);

Step 3: Invoke connector operation

1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

   Following is an example on how to get articles using the connector. Here we have given the complete URL of a specific news item, URL-encoded or backslash-escaped.

   Get articles

   public function main() {
       nt:InlineResponse200|error response = baseClient->getContents("https%3A%2F%2Fwww.nytimes.com%2F2018%2F09%2F19%2Fworld%2Fasia%2Fnorth-south-korea-nuclear-weapons.html");
       if (response is nt:InlineResponse200) {
           log:printInfo(response.toString());
       } else {
           log:printError(response.message());
       }
   }

   Following is an example on how to filter articles using the connector. You can now filter by source and section articles.

   The following values are allowed for the source:

   • all = items from both The New York Times and The International New York Times
   • nyt = New York Times items only
   • inyt = International New York Times items only (FKA The International Herald Tribune)

   The following values are allowed for the section:

   • all | A section name

   Filter articles

   public function main() {
       nt:InlineResponse200|error response = baseClient->filterContents("all", "world");
       if (response is InlineResponse200) {
           log:printInfo(response.toString());
       } else {
           log:printError(response.message());
       }
   }

   Following is an example on how to filter articles by time using the connector. You can now filter by source and section articles.

   The following values are allowed for the source:

   • all = items from both The New York Times and The International New York Times
   • nyt = New York Times items only
   • inyt = International New York Times items only (FKA The International Herald Tribune)

   The following values are allowed for the section:

   • all | A section name The time-period field limits the set of items by time published, integer in number of hours.

   Filter articles by time.

   public function main() {
       nt:InlineResponse200|error response = baseClient->filterContentsByTime("all", "world", 24);
       if (response is nt:InlineResponse200) {
           log:printInfo(response.toString());
       } else {
           log:printError(response.message());
       }
   }

2. Use bal run command to compile and run the Ballerina program.