| Eyve Geordan | J Tyler Sheppard | Ashwin Swamy | Harsh Desai |
|---|---|---|---|
 |
 |
 |
 |
 |
|
|
|
Production Endpoint 👉 https://quake-ds-production.herokuapp.com/
Staging Endpoint 👉 https://quake-ds-staging.herokuapp.com/
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /lastQuake/SOURCE/MAGNITUDE |
all users | Returns the last quake over the given magnitude from the source |
| GET | /last/SOURCE/TIME/MAGNITUDE |
all users | Gets the quakes over the given timeframe |
| GET | /history/SOURCE/LAT,LON,DIST |
all users | Returns all quakes in a given area |
| GET | /zip/ZIPCODE/DIST |
all users | Returns last quake in a given area |
| GET, POST | /comments/SOURCE/QUAKE |
all users | Gets or Posts comments about quakes |
/lastQuake/SOURCE/MAGNITUDE- Returns the last quake over the given magnitude from the source
SOURCE: choice of 'USGS' or 'EMSC' depending on which datasource to pull from
MAGNITUDE: a number 0-11 (accepts floats and ints) defaults to 5.5
/last/SOURCE/TIME/MAGNITUDE- Gets the quakes over the given timeframe
SOURCE: choice of 'USGS' or 'EMSC' depending on which datasource to pull from
TIME: choice of 'hour', 'day', 'week' or 'month', returns quakes over the given time period
MAGNITUDE: a number 0-11 (accepts floats and ints) defaults to 5.5
/history/SOURCE/LAT,LON,DIST- Returns all quakes in a given area
SOURCE: choice of 'USGS' or 'EMSC' depending on which datasource to pull from
LAT and LON are the central latitude and longitude
DIST is the distance in miles from the center to search from
/zip/ZIPCODE/DIST- reutrns last quake around a given zip code
ZIPCODE: a US 5 digit zip code
DIST: the distance out to check for the last quake, defaults to 20km
/comments/SOURCE/QUAKE- gets or posts comments about quakes
SOURCE: choice of 'USGS' or 'EMSC' depending on which datasource the quake is in
QUAKE: the earthquake's ID number
The history routes will return data in the following format:
"message": Contains the quakes returned in format:
"Oceanic": a boolean value for if the quake was in the ocean (only for USGS quakes, not reliable),
"id": A numerical id of the quake in our database (unique per quake),
"lat": lattitude in degrees
"lon": longitude in degrees
"mag": Magnitude of the earthquake
"place": a Human readable representation of approximatly where the quake is
"time": the time that the quake occured in UTC in ms since Epoch}
"num_quakes": the number of quakes returned
"status_code": standard web status codes
"boundingA": Only returned on history route, Northwest corner of the bounding box
"boundingB": Only returned on history route, Southeast corner of the bounding box
The comments route will return data in the following format:
"message": contains a list of comments in the format:
"name": the display name of the User
"comment": the comment
"num_comments": the number of comments returned
"status_code": web status codes
Our primary data source is the USGS geojson feed. View the documentation, or search their data. For a further history of earthquakes we also collected the data available on EMSC
Source code for the API is available GitHub Source code for the Dashboard is also available in this repo We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented. If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project. Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.