national-geographic-api
v2.0.6
Published
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.
Downloads
9
Maintainers
Readme
national-geographic-api
NodeJS National Geographic API
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 itemsPAGE_NUMBER
- optional, defaults to page 0CALLBACK
- 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 formatCALLBACK
- optional, if no callback provided returns a promise