Socket
Socket
Sign inDemoInstall

national-geographic-api

Package Overview
Dependencies
47
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

national-geographic-api

National Geographic API that can be used to retrieve the latest news, the latest photo of the day, with the ability to query historical news and historical photos.


Version published
Maintainers
1
Weekly downloads
3
decreased by-25%

Weekly downloads

Readme

Source

national-geographic-api

NodeJS National Geographic API

version travis build codecov coverage dependency status Known Vulnerabilities Codacy Badge MIT License semantic-release Commitizen friendly stability-stable Greenkeeper code style

Table of Contents

Documentation

You can find documentation here

Installation

npm i national-geographic-api

Setup

Import

const natgeo = require('national-geographic-api').NationalGeographicAPI;

or

import {NationalGeographicAPI} from 'national-geographic-api';

Features

  • Get Latest News articles with title, description, img and other metadata
  • Paginate news digest
  • Promises and callback support on all functions, if no callback provided, promise returned, allows you to manage flow as you desire
  • Typescript code with typings

Latest News

Returns the latest news from National Geographic News API with metadata.

natgeo.getLatestNews(`PAGE_SIZE` , `PAGE_NUMBER` , `CALLBACK` )
    .then((result) => ...);

or

const result = await NationalGeographicAPI.getLatestNews(`PAGE_SIZE` , `PAGE_NUMBER` , `CALLBACK`);
  • PAGE_SIZE - optional, defaults to 3 story items
  • PAGE_NUMBER - optional, defaults to page 0
  • CALLBACK - optional, if no callback provided returns a promise

Photo of the Day

Returns requested Photo of the Day from National Geographic archives.

natgeo.getPhotoOfDay(`DAY` , `CALLBACK`)
    .then((result) => ...);

or

const result = await NationalGeographicAPI.getPhotoOfDay(`DAY` , `CALLBACK`);
  • DAY - optional, defaults to today. Expects ISO date format
  • CALLBACK - optional, if no callback provided returns a promise

Keywords

FAQs

Last updated on 10 May 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc