This repository has been archived by the owner. It is now read-only.
DEPRECATED - Elixir client for EVE Online's CREST API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
lib
test
.drone.yml
.gitignore
CHANGELOG.md
LICENSE
README.md
mix.exs
mix.lock

README.md


⚠️⚠️⚠️⚠️⚠️


This project is not maintained anymore! Please check here for alternatives. This repository is kept online for reference purposes only and can be taken offline/deleted any time.


⚠️⚠️⚠️⚠️⚠️


CREST

Build Status hex.pm version hex docs

A simple client for EVE Online's CREST API. This client correctly specifies version headers for requests, handles transparent, parallel page-walking and connection-pooling. Results are returned as (list of) maps.

Currently WIP, endpoints are added as needed. Check the docs for available endpoints. Contributions are very welcome!

Configuration

You need to define the following variables for configuring the client in your application's config.exs:

config :crest,
  host: "crest-tq.eveonline.com", # Change host to point it at e.g. sisi
  port: 443,                      # Change port if you're using a custom proxy (TLS must be supported)
  max_sessions: 20,               # Maximum number of parallel connections
  max_pipeline_size: 150          # Maximum size of HTTP pipeline per connection

Installation

The package can be installed as:

  1. Add crest to your list of dependencies in mix.exs:
```elixir
def deps do
  [{:crest, github: "EVE-Tools/crest"}]
end
```
  1. Ensure crest is started before your application:
```elixir
def application do
  [applications: [:crest]]
end
```