Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

everest

Everest is a REST API for EVE static data. To start with it only supports routes and jump counts.

Usage

There are two API groups right now: GET /route/ and GET /jump/

Route

The route takes a source and destination and gives the shortest path between the two places. Route can take system names, system IDs, or any combination of the two.

GET /route/Jita/Perimiter/

{
  "count": 1,
  "route": [
  {
    "id": 30000142,
    "name": "Jita"
  },
  {
    "id": 30000144,
    "name": "Perimeter"
  }]
}

Route can also take station names or IDs via GET /route/station/<source>/<destination>/

Security Avoidance

Route can also be configured to avoid certain systems with a given sec status. For instance, to avoid all null and high sec systems, append /highonly/ to the request. To avoid high sec, append /nohigh/. This will result in routes that contain no entries of the given security status. If the start or end points fall in the avoidance list, everest will return an empty set.

Jump Count

In case you don't want the entire route and just want the jump count, GET /jump/ is for you. Just like route, there is a station mode GET /jump/station/. Again, it can take any combination of names and IDs. It also support security avoidance like the route API and is used in the same manner.

GET /jump/Jita/Rens/

{
  "jumps": 15
}

Batched Jump Count

If you need more than a few jump counts you should make use of the batched API. POST /jump/batch/ accepts json data with one source and multiple destinations. Each location can be a system name or ID, or a station name or ID.

POST /jump/batch/

{
  "source": "Jita",
  "destinations": [
    "Rens",
    "Irjunen"
  ]
}

The response to the request looks like this:

{
  "source": "Jita",
  "destinations": [{
    "jumps": 15,
    "destination": "Rens"
  }, {
    "jumps": 6,
    "destination": "Irjunen"
  }]
}

Industry

The industry API is used to fetch T2 blueprint details. There are two modes for retrieving these: getting all blueprints by category (or just all of them) and then pulling information for a specific item. See the howto under docs for more details.

Configuration

To run this locally you'll need everyting in requirements.txt. You can either edit config.py directory or add a configuration file to your environment. For local development, I have a file called debug.cfb, and everest looks for that via EVEREST_CONFIG (so, export EVEREST_CONFIG=debug.cfg).

Unit Tests

There are unit tests. They do, however, require the database to run. Run them via python everest_test.py.

About

Everest is a RESTful API for a subset of EVE static data.

Resources

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.