Frontier World API

CCP have published a REST API giving access to a wide range of endpoints, in each case they have published an OpenAPI compliant specification:

  • Stillness (Closed Alpha): https://blockchain-gateway-stillness.live.tech.evefrontier.com/ (Swagger)
  • Nova (Builder Sandbox): https://world-api-nova.live.tech.evefrontier.com/ (Swagger)

API Reference (Stillness)

The following reference is auto-generated from the Stillness Swagger spec (data/world-api-stillness.json).

API Version: v1.0.1 |  Spec: Swagger 2.0

Meta

GET /config

get config

retrieve all the config needed to connect to our services

Responses

StatusDescriptionSchema
200 OK models.ChainConfig
400 Bad Request
404 Not Found
500 Internal Server Error

GET /health

health endpoint

Tells you if the World API is ok

Responses

StatusDescriptionSchema
200 OK routes.heatlhy
400 Bad Request
404 Not Found
500 Internal Server Error

POST /v2/pod/verify

verify a POD

verify a Provable Object Datatype object

Parameters

NameInTypeRequiredDescription
pod body pod.Pod POD to verify

Responses

StatusDescriptionSchema
200 OK v2.verifyResponse
400 Bad Request

Game

GET /v2/characters/me/jumps

list all the jumps for the current user

returns all the gate jumps that the current authenticated user made

🔐 Authentication required — Bearer token via Authorization header.

Responses

StatusDescriptionSchema
200 jumps with some metadata object
401 Unauthorized
500 Internal Server Error

GET /v2/characters/me/jumps/{id}

get a single jump

returns a single jump by the given id that the current authenticated user made

🔐 Authentication required — Bearer token via Authorization header.

Parameters

NameInTypeRequiredDescription
id path string Jump ID
Example: 1745854210705
format query string
Enum: json, pod
Format of the response (default to json)

Responses

StatusDescriptionSchema
200 the detailed jump v2.jumpResponse
201 when generating a POD (with ?format=pod) pod.Pod
400 Bad Request
401 Unauthorized
500 Internal Server Error

GET /v2/ships

get all the ships

list all the ships Endpoint is paginated, use the limit/offset query param to paginate

Parameters

NameInTypeRequiredDescription
limit query number Maximum number of ships to return
Example: 100
Max: 1000
offset query number Number of ships to skip before starting to collect the results

Responses

StatusDescriptionSchema
200 ships with some metadata object
400 Bad Request

GET /v2/ships/{id}

get ship

get details about a single ship

Parameters

NameInTypeRequiredDescription
id path string ship type ID
Example: 73192
format query string
Enum: json, pod
Format of the response (default to json)

Responses

StatusDescriptionSchema
200 OK v2.detailedShipResponse
201 when generating a POD (with ?format=pod) pod.Pod
400 Bad Request
404 Not Found
500 Internal Server Error

GET /v2/tribes

get all the tribes

list all the tribes currently in the game Endpoint is paginated, use the limit/offset query param to paginate

Parameters

NameInTypeRequiredDescription
limit query number Maximum number of tribes to return
Example: 10
Max: 1000
offset query number Number of tribes to skip before starting to collect the results

Responses

StatusDescriptionSchema
200 tribes with some metadata object
400 Bad Request

GET /v2/tribes/{id}

get one tribe

get details about a single tribe

Parameters

NameInTypeRequiredDescription
id path string Tribe ID
Example: 1000167
format query string
Enum: json, pod
Format of the response (default to json)

Responses

StatusDescriptionSchema
200 OK v2.detailedTribeResponse
201 when generating a POD (with ?format=pod) pod.Pod
400 Bad Request
404 Not Found
500 Internal Server Error

GET /v2/types

get all the game types

list all the game types Endpoint is paginated, use the limit/offset query param to paginate

Parameters

NameInTypeRequiredDescription
limit query number Maximum number of types to return
Example: 100
Max: 1000
offset query number Number of types to skip before starting to collect the results

Responses

StatusDescriptionSchema
200 game types with some metadata object
400 Bad Request

GET /v2/types/{id}

get game type

get details about a single game type

Parameters

NameInTypeRequiredDescription
id path string game type ID
Example: 73192
format query string
Enum: json, pod
Format of the response (default to json)

Responses

StatusDescriptionSchema
200 OK v2.typeResponse
201 when generating a POD (with ?format=pod) pod.Pod
400 Bad Request
404 Not Found
500 Internal Server Error

Universe

GET /v2/constellations

get all the constellations

list all the constellations currently in the game Endpoint is paginated, use the limit/offset query param to paginate

Parameters

NameInTypeRequiredDescription
limit query number Maximum number of constellations to return
Example: 10
Max: 1000
offset query number Number of constellations to skip before starting to collect the results

Responses

StatusDescriptionSchema
200 constellations with some metadata object
400 Bad Request

GET /v2/constellations/{id}

get one constellation

get details about a single constellation

Parameters

NameInTypeRequiredDescription
id path string Constellation ID
Example: 20000004
format query string
Enum: json, pod
Format of the response (default to json)

Responses

StatusDescriptionSchema
200 OK v2.constellationResponse
201 when generating a POD (with ?format=pod) pod.Pod
400 Bad Request
404 Not Found
500 Internal Server Error

GET /v2/solarsystems

get all the solar systems

list all the solar systems currently in the game Endpoint is paginated, use the limit/offset query param to paginate

Parameters

NameInTypeRequiredDescription
limit query number Maximum number of solar systems to return
Example: 10
Max: 1000
offset query number Number of solar systems to skip before starting to collect the results

Responses

StatusDescriptionSchema
200 solar systems with some metadata object
400 Bad Request

GET /v2/solarsystems/{id}

get one solar system

get details about a single solar system

Parameters

NameInTypeRequiredDescription
id path string Solar System ID
Example: 30000001
format query string
Enum: json, pod
Format of the response (default to json)

Responses

StatusDescriptionSchema
200 OK v2.detailedSolarSystemResponse
201 when generating a POD (with ?format=pod) pod.Pod
400 Bad Request
404 Not Found
500 Internal Server Error

Data Models

big.Int

Type: object

models.ChainConfig

FieldTypeDescription
podPublicSigningKey string

pod.Pod

FieldTypeDescription
entries pod.PodEntries
signature string
signerPublicKey string

pod.PodEntries

Type: map[string]pod.PodValue

pod.PodValue

FieldTypeDescription
bigVal big.Int
boolVal boolean
bytesVal []integer
stringVal string
timeVal string
valueType pod.PodValueType

pod.PodValueType

Type: string (enum)

Values: null, string, bytes, cryptographic, int, boolean, eddsa_pubkey, date

routes.heatlhy

FieldTypeDescription
ok boolean

v2.constellationResponse

FieldTypeDescription
id integer
location v2.gameLocationResponse
name string
regionId integer
solarSystems []v2.solarSystemResponse

v2.detailedShipResponse

FieldTypeDescription
capacitor v2.shipCapacitor
classId integer
className string
cpuOutput number
damageResistances v2.shipResistances
description string
fuelCapacity number
health v2.shipHealth
id integer
name string
physics v2.shipPhysics
powergridOutput number
slots v2.shipSlots

v2.detailedSolarSystemResponse

FieldTypeDescription
constellationId integer
gateLinks []v2.gateLinkWithDestinationSolarSystemResponse
id integer
location v2.gameLocationResponse
name string
regionId integer

v2.detailedTribeResponse

FieldTypeDescription
description string
id integer
name string
nameShort string
taxRate number
tribeUrl string

v2.gameLocationResponse

FieldTypeDescription
x number
y number
z number

v2.gateLinkWithDestinationSolarSystemResponse

FieldTypeDescription
destination v2.solarSystemResponse
id integer
location v2.gameLocationResponse
name string

v2.jumpResponse

FieldTypeDescription
destination v2.solarSystemResponse
id integer for now the Id is the jump Time as a UNIX ms timestamp
origin v2.solarSystemResponse
ship v2.jumpShipResponse
time string

v2.jumpShipResponse

FieldTypeDescription
instanceId integer
typeId integer

v2.paginatedResponse

FieldTypeDescription
data object
metadata v2.paginationMetadata

v2.paginationMetadata

FieldTypeDescription
limit integer
offset integer
total integer

v2.resistance

FieldTypeDescription
emDamage number
explosiveDamage number
kineticDamage number
thermalDamage number

v2.shipCapacitor

FieldTypeDescription
capacity number
rechargeRate number

v2.shipHealth

FieldTypeDescription
armor integer
shield integer
structure integer

v2.shipHeat

FieldTypeDescription
conductance number
heatCapacity number

v2.shipPhysics

FieldTypeDescription
heat v2.shipHeat
inertiaModifier number
mass number
maximumVelocity number

v2.shipResistances

FieldTypeDescription
armor v2.resistance
shield v2.resistance
structure v2.resistance

v2.shipResponse

FieldTypeDescription
classId integer
className string
description string
id integer
name string

v2.shipSlots

FieldTypeDescription
high integer
low integer
medium integer

v2.solarSystemResponse

FieldTypeDescription
constellationId integer
id integer
location v2.gameLocationResponse
name string
regionId integer

v2.tribeResponse

FieldTypeDescription
description string
id integer
name string
nameShort string
taxRate number
tribeUrl string

v2.typeResponse

FieldTypeDescription
categoryId integer
categoryName string
description string
groupId integer
groupName string
iconUrl string
id integer
mass number
name string
portionSize integer
radius number
volume number

v2.verifyResponse

FieldTypeDescription
error string
isValid boolean

Authentication

BearerAuth

PropertyValue
TypeapiKey
NameAuthorization
Inheader