Skip to content

TruitMeGood/node-atlas-obscura

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-atlas-obscura

An API Wrapper for Atlas Obscura

Installation

npm install --save node-atlas-obscura

Usage

const Atlas = require("node-atlas-obscura");
const atlas = new Atlas();

Get places in a city

atlas.getPlaces({
  city: "Berlin",
  country: "Germany",
  orderByRecent: false,
});
/*
If true, this method will show most recent places added for this location
*/

Get food places in a city

atlas.getFoodPlaces({
  city: "Berlin",
  country: "Germany",
});

Get place details

atlas.getPlaceById(placeId, (placeOnly = true));
/*
If false, this method will also return places nearby this one
*/

Get tags for a city

atlas.getTags({
  city: "Berlin",
  country: "Germany",
});

Get places by tag

atlas.getPlacesByTag({
  city: "Berlin",
  country: "Germany",
  tag: "art",
});

Get most popular places

atlas.getPopular();

Get all places

atlas.getAllPlaces();

Search by keyword

atlas.search(keyword, isPlace = false);

Get user lists

atlas.getUserLists(username);

Get user list

atlas.getUserList(username, listName);

About

An API Wrapper for Atlas Obscura

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published