A proxy service for APIs in the Eve online domain.
Some notable examples are:
- Redisq - the only live-streaming killmail service in existence.
- Zkb - the grand daddy of all killboards
- Evewho - character and corporation lookup
A docker image is available from Github Container Registry.
docker pull ghcr.io/tonycknight/eveproxy:<latest tag>
You'll also need a MongoDB database installed, available and protected. Please note that the database is not created nor maintained. See the MongoDB documentation on how to install and create databases
Start the container:
docker run -it --rm --publish 8080:8080 eveproxy:<tag> --mongoDbName "<database name>" --mongoConnection "<connection string>"
The parameters you'll need to pass are:
mongoDbName |
The name of the database within the Mongo installation. |
mongoConnection |
The connection string to the Mongo DB. |
Trace telemetry is on by default. The available log levels are None, Trace, Debug, Information, Warning, Error & Critical.
To select the log levels you want, specify the log levels as command line arguments.
Each argument follows this pattern:
--Logging:Console:LogLevel:<Namespace>=<log level>
| Namespace | Default log level | |
|---|---|---|
Microsoft.Hosting.Lifetime |
Information |
App start up and shutdown |
eveproxy |
Trace |
All telemetry from the eveproxy namespace |
Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware |
Information |
HTTP request and response telemetry |
For example, to show only eveproxy warnings:
--Logging:Console:LogLevel:eveproxy=Warning
GET /api/stats/ |
Get statistics on the API's use. |
GET /api/heartbeat/ |
Check the API is alive |
GET /api/redisq/v1/kills/ |
Get the next-in-sequence killmail. |
GET /api/redisq/v1/kills/id/[id]/ |
Get the killmail of id if it's been cached. |
GET /api/redisq/v1/kills/session/[session]/ |
Sessions are analogous to queues. To get a specific stream of kills, just give a unique name for session. |
GET /api/zkb/v1/[Zkb API route]/ |
Send GET traffic to the given Zkb API route. For example, use /api/zkb/v1/losses/solo/ to get solo losses. See the zkb wiki for details. |
GET /api/evewho/v1/[evewho API route]/ |
Send GET traffic to the given evewho API route. For example, use /api/zkb/v1/character/1633218082 to get details on a character. See evewho for details. |
This API proxies the wonderful work of cvweiss & Zkillboard's Redisq.
All data coming through eveproxy is copyright CCP hf. See CCP.