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: v0.1.38 |  Spec: Swagger 2.0

Meta

GET /abis/config

get ABI with some config

retrieve the world contracts ABIs with some config

Responses

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

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 —

Chain

POST /metatransaction

submit a meta transaction

submit a meta transaction Only bringOnline, bringOffline and setEntityMetadata are allowed

Parameters

NameInTypeRequiredDescription
request body v1.ERC2771 ✅ ERC2771 Meta TX object

Responses

StatusDescriptionSchema
201 Created —
400 Bad Request —
404 Not Found —
500 Internal Server Error —

GET /v2/killmails

get all reported killmails

Retrieve all killmails that have been saved to the chain Endpoint is paginated, use the limit/offset query param to paginate

Parameters

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

Responses

StatusDescriptionSchema
200 killmail response with some metadata object
400 Bad Request —
500 Internal Server Error —

GET /v2/killmails/{id}

get a single killmail

returns a single killmail by the given id

Parameters

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

Responses

StatusDescriptionSchema
200 the detailed killmail v2.killMailResponse
201 when generating a POD (with ?format=pod) pod.Pod
400 Bad Request —
404 Not Found —
500 Internal Server Error —

GET /v2/smartassemblies

get all the smart assemblies

list all the smart assemblies currently in the world Endpoint is paginated, use the limit/offset query param to paginate

Parameters

NameInTypeRequiredDescription
limit query number ❌ Maximum number of smart assemblies to return
Example: 10
Max: 100
offset query number ❌ Number of smart assemblies to skip before starting to collect the results
type query string ❌ Type of smart assembly to return
Example: SmartStorageUnit, SmartGate, SmartTurret

Responses

StatusDescriptionSchema
200 smart assemblies with some metadata object
400 Bad Request —
500 Internal Server Error —

GET /v2/smartassemblies/{id}

get a single smart assembly

Retrieve one Smart Assembly with the given id if the assembly is a gate then the .gate{} will be filled if the assembly is a storage unit then the .storage{} object will be filled

Parameters

NameInTypeRequiredDescription
id path string ✅ Smart Assembly ID
Example: 45731444223951840915743646025801713404901938965911491786681215016516925828631
format query string
Enum: json, pod		 ❌ Format of the response (default to json)

Responses

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

GET /v2/smartcharacters

get all the smart characters

list all the smart characters currently in the world Endpoint is paginated, use the limit/offset query param to paginate

Parameters

NameInTypeRequiredDescription
limit query number ❌ Maximum number of smart characters to return
Example: 10
Max: 100
offset query number ❌ Number of smart characters to skip before starting to collect the results

Responses

StatusDescriptionSchema
200 smart characters with some metadata object
400 Bad Request —
500 Internal Server Error —

GET /v2/smartcharacters/{address}

get a single smart character

retrieve one smart character with the given address

Parameters

NameInTypeRequiredDescription
address path string ✅ character hex address
Example: 0x7578ca43f52db0d859b3f2081c1464080fe47c00
format query string
Enum: json, pod		 ❌ Format of the response (default to json)

Responses

StatusDescriptionSchema
200 OK v2.detailedSmartCharacterResponse
201 when generating a POD (with ?format=pod) pod.Pod
404 Not Found —
422 Unprocessable Entity —
500 Internal Server Error —

Game

GET /v2/fuels

available fuels for the smart assemblies

Responses

StatusDescriptionSchema
200 fuels with some metadata object
500 Internal Server Error —

GET /v2/smartcharacters/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/smartcharacters/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/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 —

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 —

Data Models

big.Int

Type: object

models.AddressConfig

FieldTypeDescription
address string

models.ChainConfig

FieldTypeDescription
EVEToLuxExchangeRate number
baseDappUrl string
blockExplorerUrl string
chainId integer
contracts models.Contracts
cycleStartDate string
exchangeWalletAddress string
indexerUrl string
ipfsApiUrl string
itemTypeIDs models.ItemTypeIDs
metadataApiUrl string
name string
nativeCurrency models.NativeCurrency
podPublicSigningKey string
rpcUrls models.RPCs
systems models.SystemIds
vaultDappUrl string
walletApiUrl string

models.Contracts

FieldTypeDescription
contractsVersion string
eveToken models.AddressConfig
forwarder models.AddressConfig
lensSeller models.AddressConfig
world models.AddressConfig

models.ItemTypeIDs

FieldTypeDescription
fuel integer

models.NativeCurrency

FieldTypeDescription
decimals integer
name string
symbol string

models.RPCURls

FieldTypeDescription
http string
webSocket string

models.RPCs

FieldTypeDescription
default models.RPCURls
public models.RPCURls

models.SystemIds

FieldTypeDescription
approveEVE string
bringOffline string
bringOnline string
createAndAnchorSmartGate string
createAndAnchorSmartStorageUnit string
createAndAnchorSmartTurret string
createAndDepositItemsToEphemeralInventory string
createAndDepositItemsToInventory string
createCharacter string
depositFuel string
depositToSSU string
destroyDeployable string
purchaseItem string
reportKill string
transfer string
unanchor string
updateFuel string
withdrawFromEphemeralInventory string
withdrawFromInventory string
withdrawFuel 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.ABIConfig

FieldTypeDescription
EVE_to_LUX_exchange_rate number
base_dapp_url string
cfg []routes.AbiCfg
exchange_wallet_address string
system_ids models.SystemIds
systems []integer
vault_dapp_url string

routes.AbiCfg

FieldTypeDescription
abi []integer
chain_id integer
deployed_to string
eip712 routes.EIP712
name string
urls routes.URLs

routes.EIP712

FieldTypeDescription
name string
version string

routes.URLs

FieldTypeDescription
private []string
public []string

routes.heatlhy

FieldTypeDescription
ok boolean

v1.ERC2771

FieldTypeDescription
data string
deadline integer
from string
gas integer
nonce string
signature string
to string
value integer

v2.burnResponse

FieldTypeDescription
isBurning boolean
previousCycleElapsedTimeInSec integer
startTime string

v2.detailedSmartAssemblyResponse

FieldTypeDescription
dappURL string
description string
energyUsage integer
gate v2.gateResponse
id string
location v2.gameLocationResponse
manufacturing v2.manufacturingResponse
name string
networkNode v2.networkNodeResponse
owner v2.smartCharacterResponse
refinery v2.refineryResponse
solarSystem v2.solarSystemResponse
state v2.smartAssemblyStateEnum
storage v2.storageResponse
turret v2.turretResponse
type v2.smartAssemblyTypeEnum
typeDetails v2.typeResponse
typeId integer

v2.detailedSmartCharacterResponse

FieldTypeDescription
address string
eveBalanceInWei string
gasBalanceInWei string
id string
name string
portraitUrl string
smartAssemblies []v2.smartAssemblyResponse
tribeId integer

v2.detailedSolarSystemResponse

FieldTypeDescription
constellationId integer
id integer
location v2.gameLocationResponse
name string
regionId integer
smartAssemblies []v2.smartAssemblyResponse

v2.detailedTribeResponse

FieldTypeDescription
description string
foundedAt string
id integer
memberCount integer
members []v2.smartCharacterResponse
name string
nameShort string
taxRate number
tribeUrl string

v2.ephemeralInventoryResponse

FieldTypeDescription
capacity string
items []v2.itemResponse
owner v2.smartCharacterResponse
usedCapacity string

v2.fuelResponse

FieldTypeDescription
efficiency integer
type v2.typeResponse

v2.gameLocationResponse

FieldTypeDescription
x number
y number
z number

v2.gateResponse

FieldTypeDescription
destinationId string
inRange []v2.smartAssemblyResponse
isParentNodeOnline boolean
linked boolean

v2.inventoryResponse

FieldTypeDescription
capacity string
items []v2.itemResponse
usedCapacity string

v2.itemResponse

FieldTypeDescription
image string
itemId integer
name string
quantity integer
typeId integer

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.killMailResponse

FieldTypeDescription
id integer
killer v2.smartCharacterResponse
solarSystemId integer
time string
victim v2.smartCharacterResponse

v2.loadedFuelResponse

FieldTypeDescription
amount integer
burnRateInSec integer
efficiency integer
typeId integer
unitVolume integer

v2.manufacturingResponse

FieldTypeDescription
isParentNodeOnline boolean

v2.networkNodeResponse

FieldTypeDescription
burn v2.burnResponse
energyMaxCapacity integer
energyProduction integer
fuel v2.loadedFuelResponse
linkedAssemblies []v2.smartAssemblyResponse
totalReservedEnergy integer

v2.paginatedResponse

FieldTypeDescription
data object
metadata v2.paginationMetadata

v2.paginationMetadata

FieldTypeDescription
limit integer
offset integer
total integer

v2.refineryResponse

FieldTypeDescription
isParentNodeOnline boolean

v2.scanResponse

FieldTypeDescription
id integer
location v2.solarSystemResponse
scannedObject v2.scannedObjectResponse
time string

v2.scannedObjectResponse

FieldTypeDescription
mass integer
name string
owner string
typeID integer

v2.smartAssemblyResponse

FieldTypeDescription
energyUsage integer
id string
name string
owner v2.smartCharacterResponse
solarSystem v2.solarSystemResponse
state v2.smartAssemblyStateEnum
type v2.smartAssemblyTypeEnum
typeDetails v2.typeResponse
typeId integer

v2.smartAssemblyStateEnum

Type: string (enum)

Values: unknown, unanchored, anchored, online, offline, destroyed

v2.smartAssemblyTypeEnum

Type: string (enum)

Values: SmartStorageUnit, SmartTurret, SmartGate, NetworkNode, Refinery, Manufacturing, SmartHangar, Unknown

v2.smartCharacterResponse

FieldTypeDescription
address string
id string
name string

v2.solarSystemResponse

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

v2.storageResponse

FieldTypeDescription
ephemeralInventories []v2.ephemeralInventoryResponse
isParentNodeOnline boolean
mainInventory v2.inventoryResponse

v2.tribeResponse

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

v2.turretResponse

FieldTypeDescription
isParentNodeOnline boolean

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