Skip to content

sdclarkelab/jamaica-iss-tracker-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jamaica-iss-tracker-api

This API https://jam-iss-tracker.herokuapp.com/api/v1/iss/sightings shows the International Space Station (ISS) sightings dates and times in Jamaica cities (Kingston, Montego Bay) by default.

How to run

Enter the following command to run the project on your local machine:

$ pip install -r requirements.txt
$ uvicorn main:app --reload

Documentation

See https://jam-iss-tracker.herokuapp.com/docs for API documentation.

Query Format

To filter on other countries use the following query parameters:

  • country
  • region
  • city_names

See the following examples:

Example #1

https://jam-iss-tracker.herokuapp.com/api/v1/iss/sightings?country=Canada&region=Ontario&city_names=Toronto

Example #2

https://jam-iss-tracker.herokuapp.com/api/v1/iss/sightings?country=Jamaica&region=None&city_names=Kingston,Montego_Bay