Etro API

If you use Discord login, you will need to use Token authentication below. You can get the token by opening DevTools (default F12) and refreshing Etro, then examine any network request's authorization header.

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

auth

POST /api/auth/discord/login/

Discord OAuth2 Login

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`access_token`
`code`
`id_token`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth discord login create -p access_token=... -p code=... -p id_token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "discord > login > create"]
var params = {
    access_token: ...,
    code: ...,
    id_token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "discord > login > create"]
params = {
    "access_token": ...,
    "code": ...,
    "id_token": ...,
}
result = client.action(schema, action, params=params)

POST /api/auth/login/

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework Accept the following POST parameters: username, password Return the REST Framework Token Object's key.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`
`email`
`password` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth login create -p username=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "login > create"]
var params = {
    username: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "login > create"]
params = {
    "username": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

logout > list

GET /api/auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth logout list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "logout > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "logout > list"]
result = client.action(schema, action)

logout > create

POST /api/auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth logout create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "logout > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "logout > create"]
result = client.action(schema, action)

password > change > create

POST /api/auth/password/change/

Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`new_password1` required
`new_password2` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth password change create -p new_password1=... -p new_password2=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "password > change > create"]
var params = {
    new_password1: ...,
    new_password2: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "password > change > create"]
params = {
    "new_password1": ...,
    "new_password2": ...,
}
result = client.action(schema, action, params=params)

password > reset > create

POST /api/auth/password/reset/

Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth password reset create -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "password > reset > create"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "password > reset > create"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

password > reset > confirm > create

POST /api/auth/password/reset/confirm/

Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`new_password1` required
`new_password2` required
`uid` required
`token` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth password reset confirm create -p new_password1=... -p new_password2=... -p uid=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "password > reset > confirm > create"]
var params = {
    new_password1: ...,
    new_password2: ...,
    uid: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "password > reset > confirm > create"]
params = {
    "new_password1": ...,
    "new_password2": ...,
    "uid": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

password > reset > confirm > read

GET /api/auth/password/reset/confirm/{uidb64}/{token}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`uidb64` required
`token` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth password reset confirm read -p uidb64=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "password > reset > confirm > read"]
var params = {
    uidb64: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "password > reset > confirm > read"]
params = {
    "uidb64": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

registration > create

POST /api/auth/registration/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required
`email` required
`password1` required
`password2` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth registration create -p username=... -p email=... -p password1=... -p password2=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "registration > create"]
var params = {
    username: ...,
    email: ...,
    password1: ...,
    password2: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "registration > create"]
params = {
    "username": ...,
    "email": ...,
    "password1": ...,
    "password2": ...,
}
result = client.action(schema, action, params=params)

registration > account-email-verification-sent > list

GET /api/auth/registration/account-email-verification-sent/

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth registration account-email-verification-sent list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "registration > account-email-verification-sent > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "registration > account-email-verification-sent > list"]
result = client.action(schema, action)

registration > verify-email > create

POST /api/auth/registration/verify-email/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`key` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth registration verify-email create -p key=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "registration > verify-email > create"]
var params = {
    key: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "registration > verify-email > create"]
params = {
    "key": ...,
}
result = client.action(schema, action, params=params)

send-email-verification > create

POST /api/auth/send-email-verification/

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth send-email-verification create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "send-email-verification > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "send-email-verification > create"]
result = client.action(schema, action)

token > refresh > create

POST /api/auth/token/refresh/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`refresh`	WIll override cookie.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth token refresh create -p refresh=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "token > refresh > create"]
var params = {
    refresh: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "token > refresh > create"]
params = {
    "refresh": ...,
}
result = client.action(schema, action, params=params)

token > verify > create

POST /api/auth/token/verify/

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`token` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth token verify create -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "token > verify > create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "token > verify > create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

user > read

GET /api/auth/user/

Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth user read

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "user > read"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "user > read"]
result = client.action(schema, action)

user > update

PUT /api/auth/user/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`defaultClan`
`defaultItemLevelRange`
`defaultPartyBonus`
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth user update -p defaultClan=... -p defaultItemLevelRange=... -p defaultPartyBonus=... -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "user > update"]
var params = {
    defaultClan: ...,
    defaultItemLevelRange: ...,
    defaultPartyBonus: ...,
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "user > update"]
params = {
    "defaultClan": ...,
    "defaultItemLevelRange": ...,
    "defaultPartyBonus": ...,
    "username": ...,
}
result = client.action(schema, action, params=params)

user > partial_update

PATCH /api/auth/user/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`defaultClan`
`defaultItemLevelRange`
`defaultPartyBonus`
`username`	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action auth user partial_update -p defaultClan=... -p defaultItemLevelRange=... -p defaultPartyBonus=... -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "user > partial_update"]
var params = {
    defaultClan: ...,
    defaultItemLevelRange: ...,
    defaultPartyBonus: ...,
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["auth", "user > partial_update"]
params = {
    "defaultClan": ...,
    "defaultItemLevelRange": ...,
    "defaultPartyBonus": ...,
    "username": ...,
}
result = client.action(schema, action, params=params)

clans

list

GET /api/clans/

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action clans list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["clans", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["clans", "list"]
result = client.action(schema, action)

read

GET /api/clans/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this clan.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action clans read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["clans", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["clans", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

equipment

list

GET /api/equipment/

List + Get endpoints for Equipment model

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`AST`
`BLM`
`BLU`
`BRD`
`DNC`
`DRG`
`DRK`
`GNB`
`MCH`
`MNK`
`NIN`
`PCT`
`PLD`
`RDM`
`RPR`
`SAM`
`SCH`
`SGE`
`SMN`
`VPR`
`WAR`
`WHM`
`ALC`
`ARM`
`BSM`
`BTN`
`CRP`
`CUL`
`FSH`
`GSM`
`LTW`
`MIN`
`WVR`
`weapon`
`head`
`body`
`hands`
`legs`
`feet`
`offHand`
`ears`
`neck`
`wrists`
`fingerL`
`fingerR`
`canCustomize`
`minItemLevel`
`maxItemLevel`
`minLevel`
`maxLevel`
`jobAbbrev`
`itemLevelSync`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action equipment list -p AST=... -p BLM=... -p BLU=... -p BRD=... -p DNC=... -p DRG=... -p DRK=... -p GNB=... -p MCH=... -p MNK=... -p NIN=... -p PCT=... -p PLD=... -p RDM=... -p RPR=... -p SAM=... -p SCH=... -p SGE=... -p SMN=... -p VPR=... -p WAR=... -p WHM=... -p ALC=... -p ARM=... -p BSM=... -p BTN=... -p CRP=... -p CUL=... -p FSH=... -p GSM=... -p LTW=... -p MIN=... -p WVR=... -p weapon=... -p head=... -p body=... -p hands=... -p legs=... -p feet=... -p offHand=... -p ears=... -p neck=... -p wrists=... -p fingerL=... -p fingerR=... -p canCustomize=... -p minItemLevel=... -p maxItemLevel=... -p minLevel=... -p maxLevel=... -p jobAbbrev=... -p itemLevelSync=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["equipment", "list"]
var params = {
    AST: ...,
    BLM: ...,
    BLU: ...,
    BRD: ...,
    DNC: ...,
    DRG: ...,
    DRK: ...,
    GNB: ...,
    MCH: ...,
    MNK: ...,
    NIN: ...,
    PCT: ...,
    PLD: ...,
    RDM: ...,
    RPR: ...,
    SAM: ...,
    SCH: ...,
    SGE: ...,
    SMN: ...,
    VPR: ...,
    WAR: ...,
    WHM: ...,
    ALC: ...,
    ARM: ...,
    BSM: ...,
    BTN: ...,
    CRP: ...,
    CUL: ...,
    FSH: ...,
    GSM: ...,
    LTW: ...,
    MIN: ...,
    WVR: ...,
    weapon: ...,
    head: ...,
    body: ...,
    hands: ...,
    legs: ...,
    feet: ...,
    offHand: ...,
    ears: ...,
    neck: ...,
    wrists: ...,
    fingerL: ...,
    fingerR: ...,
    canCustomize: ...,
    minItemLevel: ...,
    maxItemLevel: ...,
    minLevel: ...,
    maxLevel: ...,
    jobAbbrev: ...,
    itemLevelSync: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["equipment", "list"]
params = {
    "AST": ...,
    "BLM": ...,
    "BLU": ...,
    "BRD": ...,
    "DNC": ...,
    "DRG": ...,
    "DRK": ...,
    "GNB": ...,
    "MCH": ...,
    "MNK": ...,
    "NIN": ...,
    "PCT": ...,
    "PLD": ...,
    "RDM": ...,
    "RPR": ...,
    "SAM": ...,
    "SCH": ...,
    "SGE": ...,
    "SMN": ...,
    "VPR": ...,
    "WAR": ...,
    "WHM": ...,
    "ALC": ...,
    "ARM": ...,
    "BSM": ...,
    "BTN": ...,
    "CRP": ...,
    "CUL": ...,
    "FSH": ...,
    "GSM": ...,
    "LTW": ...,
    "MIN": ...,
    "WVR": ...,
    "weapon": ...,
    "head": ...,
    "body": ...,
    "hands": ...,
    "legs": ...,
    "feet": ...,
    "offHand": ...,
    "ears": ...,
    "neck": ...,
    "wrists": ...,
    "fingerL": ...,
    "fingerR": ...,
    "canCustomize": ...,
    "minItemLevel": ...,
    "maxItemLevel": ...,
    "minLevel": ...,
    "maxLevel": ...,
    "jobAbbrev": ...,
    "itemLevelSync": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/equipment/{id}/

List + Get endpoints for Equipment model

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this equipment.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`AST`
`BLM`
`BLU`
`BRD`
`DNC`
`DRG`
`DRK`
`GNB`
`MCH`
`MNK`
`NIN`
`PCT`
`PLD`
`RDM`
`RPR`
`SAM`
`SCH`
`SGE`
`SMN`
`VPR`
`WAR`
`WHM`
`ALC`
`ARM`
`BSM`
`BTN`
`CRP`
`CUL`
`FSH`
`GSM`
`LTW`
`MIN`
`WVR`
`weapon`
`head`
`body`
`hands`
`legs`
`feet`
`offHand`
`ears`
`neck`
`wrists`
`fingerL`
`fingerR`
`canCustomize`
`minItemLevel`
`maxItemLevel`
`minLevel`
`maxLevel`
`jobAbbrev`
`itemLevelSync`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action equipment read -p id=... -p AST=... -p BLM=... -p BLU=... -p BRD=... -p DNC=... -p DRG=... -p DRK=... -p GNB=... -p MCH=... -p MNK=... -p NIN=... -p PCT=... -p PLD=... -p RDM=... -p RPR=... -p SAM=... -p SCH=... -p SGE=... -p SMN=... -p VPR=... -p WAR=... -p WHM=... -p ALC=... -p ARM=... -p BSM=... -p BTN=... -p CRP=... -p CUL=... -p FSH=... -p GSM=... -p LTW=... -p MIN=... -p WVR=... -p weapon=... -p head=... -p body=... -p hands=... -p legs=... -p feet=... -p offHand=... -p ears=... -p neck=... -p wrists=... -p fingerL=... -p fingerR=... -p canCustomize=... -p minItemLevel=... -p maxItemLevel=... -p minLevel=... -p maxLevel=... -p jobAbbrev=... -p itemLevelSync=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["equipment", "read"]
var params = {
    id: ...,
    AST: ...,
    BLM: ...,
    BLU: ...,
    BRD: ...,
    DNC: ...,
    DRG: ...,
    DRK: ...,
    GNB: ...,
    MCH: ...,
    MNK: ...,
    NIN: ...,
    PCT: ...,
    PLD: ...,
    RDM: ...,
    RPR: ...,
    SAM: ...,
    SCH: ...,
    SGE: ...,
    SMN: ...,
    VPR: ...,
    WAR: ...,
    WHM: ...,
    ALC: ...,
    ARM: ...,
    BSM: ...,
    BTN: ...,
    CRP: ...,
    CUL: ...,
    FSH: ...,
    GSM: ...,
    LTW: ...,
    MIN: ...,
    WVR: ...,
    weapon: ...,
    head: ...,
    body: ...,
    hands: ...,
    legs: ...,
    feet: ...,
    offHand: ...,
    ears: ...,
    neck: ...,
    wrists: ...,
    fingerL: ...,
    fingerR: ...,
    canCustomize: ...,
    minItemLevel: ...,
    maxItemLevel: ...,
    minLevel: ...,
    maxLevel: ...,
    jobAbbrev: ...,
    itemLevelSync: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["equipment", "read"]
params = {
    "id": ...,
    "AST": ...,
    "BLM": ...,
    "BLU": ...,
    "BRD": ...,
    "DNC": ...,
    "DRG": ...,
    "DRK": ...,
    "GNB": ...,
    "MCH": ...,
    "MNK": ...,
    "NIN": ...,
    "PCT": ...,
    "PLD": ...,
    "RDM": ...,
    "RPR": ...,
    "SAM": ...,
    "SCH": ...,
    "SGE": ...,
    "SMN": ...,
    "VPR": ...,
    "WAR": ...,
    "WHM": ...,
    "ALC": ...,
    "ARM": ...,
    "BSM": ...,
    "BTN": ...,
    "CRP": ...,
    "CUL": ...,
    "FSH": ...,
    "GSM": ...,
    "LTW": ...,
    "MIN": ...,
    "WVR": ...,
    "weapon": ...,
    "head": ...,
    "body": ...,
    "hands": ...,
    "legs": ...,
    "feet": ...,
    "offHand": ...,
    "ears": ...,
    "neck": ...,
    "wrists": ...,
    "fingerL": ...,
    "fingerR": ...,
    "canCustomize": ...,
    "minItemLevel": ...,
    "maxItemLevel": ...,
    "minLevel": ...,
    "maxLevel": ...,
    "jobAbbrev": ...,
    "itemLevelSync": ...,
}
result = client.action(schema, action, params=params)

food

list

GET /api/food/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`minItemLevel`
`maxItemLevel`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action food list -p minItemLevel=... -p maxItemLevel=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["food", "list"]
var params = {
    minItemLevel: ...,
    maxItemLevel: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["food", "list"]
params = {
    "minItemLevel": ...,
    "maxItemLevel": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/food/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this food.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`minItemLevel`
`maxItemLevel`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action food read -p id=... -p minItemLevel=... -p maxItemLevel=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["food", "read"]
var params = {
    id: ...,
    minItemLevel: ...,
    maxItemLevel: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["food", "read"]
params = {
    "id": ...,
    "minItemLevel": ...,
    "maxItemLevel": ...,
}
result = client.action(schema, action, params=params)

gearsets

list

GET /api/gearsets/

List all gearsets owned by user.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "list"]
result = client.action(schema, action)

create

POST /api/gearsets/

Create a new gearset.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`minItemLevel` required
`maxItemLevel` required
`minMateriaTier`
`maxMateriaTier`
`materia`
`totalParams`
`buffs`
`relics`
`patch`
`notes`
`level`
`itemLevelSync`
`partyBonus`
`job` required
`clan`
`weapon`
`head`
`body`
`hands`
`legs`
`feet`
`offHand`
`ears`
`neck`
`wrists`
`fingerL`
`fingerR`
`food`
`medicine`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets create -p name=... -p minItemLevel=... -p maxItemLevel=... -p minMateriaTier=... -p maxMateriaTier=... -p materia=... -p totalParams=... -p buffs=... -p relics=... -p patch=... -p notes=... -p level=... -p itemLevelSync=... -p partyBonus=... -p job=... -p clan=... -p weapon=... -p head=... -p body=... -p hands=... -p legs=... -p feet=... -p offHand=... -p ears=... -p neck=... -p wrists=... -p fingerL=... -p fingerR=... -p food=... -p medicine=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "create"]
var params = {
    name: ...,
    minItemLevel: ...,
    maxItemLevel: ...,
    minMateriaTier: ...,
    maxMateriaTier: ...,
    materia: ...,
    totalParams: ...,
    buffs: ...,
    relics: ...,
    patch: ...,
    notes: ...,
    level: ...,
    itemLevelSync: ...,
    partyBonus: ...,
    job: ...,
    clan: ...,
    weapon: ...,
    head: ...,
    body: ...,
    hands: ...,
    legs: ...,
    feet: ...,
    offHand: ...,
    ears: ...,
    neck: ...,
    wrists: ...,
    fingerL: ...,
    fingerR: ...,
    food: ...,
    medicine: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "create"]
params = {
    "name": ...,
    "minItemLevel": ...,
    "maxItemLevel": ...,
    "minMateriaTier": ...,
    "maxMateriaTier": ...,
    "materia": ...,
    "totalParams": ...,
    "buffs": ...,
    "relics": ...,
    "patch": ...,
    "notes": ...,
    "level": ...,
    "itemLevelSync": ...,
    "partyBonus": ...,
    "job": ...,
    "clan": ...,
    "weapon": ...,
    "head": ...,
    "body": ...,
    "hands": ...,
    "legs": ...,
    "feet": ...,
    "offHand": ...,
    "ears": ...,
    "neck": ...,
    "wrists": ...,
    "fingerL": ...,
    "fingerR": ...,
    "food": ...,
    "medicine": ...,
}
result = client.action(schema, action, params=params)

bis

GET /api/gearsets/bis/

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets bis

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "bis"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "bis"]
result = client.action(schema, action)

read

GET /api/gearsets/{id}/

Return a specific gearset.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/gearsets/{id}/

Update a specific gearset.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`minItemLevel` required
`maxItemLevel` required
`minMateriaTier`
`maxMateriaTier`
`materia`
`totalParams`
`buffs`
`relics`
`patch`
`notes`
`level`
`itemLevelSync`
`partyBonus`
`job` required
`clan`
`weapon`
`head`
`body`
`hands`
`legs`
`feet`
`offHand`
`ears`
`neck`
`wrists`
`fingerL`
`fingerR`
`food`
`medicine`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets update -p id=... -p name=... -p minItemLevel=... -p maxItemLevel=... -p minMateriaTier=... -p maxMateriaTier=... -p materia=... -p totalParams=... -p buffs=... -p relics=... -p patch=... -p notes=... -p level=... -p itemLevelSync=... -p partyBonus=... -p job=... -p clan=... -p weapon=... -p head=... -p body=... -p hands=... -p legs=... -p feet=... -p offHand=... -p ears=... -p neck=... -p wrists=... -p fingerL=... -p fingerR=... -p food=... -p medicine=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "update"]
var params = {
    id: ...,
    name: ...,
    minItemLevel: ...,
    maxItemLevel: ...,
    minMateriaTier: ...,
    maxMateriaTier: ...,
    materia: ...,
    totalParams: ...,
    buffs: ...,
    relics: ...,
    patch: ...,
    notes: ...,
    level: ...,
    itemLevelSync: ...,
    partyBonus: ...,
    job: ...,
    clan: ...,
    weapon: ...,
    head: ...,
    body: ...,
    hands: ...,
    legs: ...,
    feet: ...,
    offHand: ...,
    ears: ...,
    neck: ...,
    wrists: ...,
    fingerL: ...,
    fingerR: ...,
    food: ...,
    medicine: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "update"]
params = {
    "id": ...,
    "name": ...,
    "minItemLevel": ...,
    "maxItemLevel": ...,
    "minMateriaTier": ...,
    "maxMateriaTier": ...,
    "materia": ...,
    "totalParams": ...,
    "buffs": ...,
    "relics": ...,
    "patch": ...,
    "notes": ...,
    "level": ...,
    "itemLevelSync": ...,
    "partyBonus": ...,
    "job": ...,
    "clan": ...,
    "weapon": ...,
    "head": ...,
    "body": ...,
    "hands": ...,
    "legs": ...,
    "feet": ...,
    "offHand": ...,
    "ears": ...,
    "neck": ...,
    "wrists": ...,
    "fingerL": ...,
    "fingerR": ...,
    "food": ...,
    "medicine": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/gearsets/{id}/

Partial update a specific gearset. WARNING: Untested.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`minItemLevel`
`maxItemLevel`
`minMateriaTier`
`maxMateriaTier`
`materia`
`totalParams`
`buffs`
`relics`
`patch`
`notes`
`level`
`itemLevelSync`
`partyBonus`
`job`
`clan`
`weapon`
`head`
`body`
`hands`
`legs`
`feet`
`offHand`
`ears`
`neck`
`wrists`
`fingerL`
`fingerR`
`food`
`medicine`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets partial_update -p id=... -p name=... -p minItemLevel=... -p maxItemLevel=... -p minMateriaTier=... -p maxMateriaTier=... -p materia=... -p totalParams=... -p buffs=... -p relics=... -p patch=... -p notes=... -p level=... -p itemLevelSync=... -p partyBonus=... -p job=... -p clan=... -p weapon=... -p head=... -p body=... -p hands=... -p legs=... -p feet=... -p offHand=... -p ears=... -p neck=... -p wrists=... -p fingerL=... -p fingerR=... -p food=... -p medicine=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "partial_update"]
var params = {
    id: ...,
    name: ...,
    minItemLevel: ...,
    maxItemLevel: ...,
    minMateriaTier: ...,
    maxMateriaTier: ...,
    materia: ...,
    totalParams: ...,
    buffs: ...,
    relics: ...,
    patch: ...,
    notes: ...,
    level: ...,
    itemLevelSync: ...,
    partyBonus: ...,
    job: ...,
    clan: ...,
    weapon: ...,
    head: ...,
    body: ...,
    hands: ...,
    legs: ...,
    feet: ...,
    offHand: ...,
    ears: ...,
    neck: ...,
    wrists: ...,
    fingerL: ...,
    fingerR: ...,
    food: ...,
    medicine: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "minItemLevel": ...,
    "maxItemLevel": ...,
    "minMateriaTier": ...,
    "maxMateriaTier": ...,
    "materia": ...,
    "totalParams": ...,
    "buffs": ...,
    "relics": ...,
    "patch": ...,
    "notes": ...,
    "level": ...,
    "itemLevelSync": ...,
    "partyBonus": ...,
    "job": ...,
    "clan": ...,
    "weapon": ...,
    "head": ...,
    "body": ...,
    "hands": ...,
    "legs": ...,
    "feet": ...,
    "offHand": ...,
    "ears": ...,
    "neck": ...,
    "wrists": ...,
    "fingerL": ...,
    "fingerR": ...,
    "food": ...,
    "medicine": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/gearsets/{id}/

Delete a specific gearset.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

clone

GET /api/gearsets/{id}/clone/

Clone a specific gearset.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action gearsets clone -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gearsets", "clone"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["gearsets", "clone"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

import

ariyala

POST /api/import/ariyala/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`ariyalaID` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action import ariyala -p name=... -p ariyalaID=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["import", "ariyala"]
var params = {
    name: ...,
    ariyalaID: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["import", "ariyala"]
params = {
    "name": ...,
    "ariyalaID": ...,
}
result = client.action(schema, action, params=params)

lodestone

POST /api/import/lodestone/

Import a gearset from a Lodestone character via XIVAPI. Either lodestoneID or gearset is required.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`lodestoneID`
`gearset`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action import lodestone -p name=... -p lodestoneID=... -p gearset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["import", "lodestone"]
var params = {
    name: ...,
    lodestoneID: ...,
    gearset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["import", "lodestone"]
params = {
    "name": ...,
    "lodestoneID": ...,
    "gearset": ...,
}
result = client.action(schema, action, params=params)

xivgear

POST /api/import/xivgear/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`xivgearURL` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action import xivgear -p xivgearURL=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["import", "xivgear"]
var params = {
    xivgearURL: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["import", "xivgear"]
params = {
    "xivgearURL": ...,
}
result = client.action(schema, action, params=params)

jobs

list

GET /api/jobs/

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action jobs list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["jobs", "list"]
result = client.action(schema, action)

read

GET /api/jobs/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this job.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action jobs read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["jobs", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["jobs", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

materia

list

GET /api/materia/

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action materia list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["materia", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["materia", "list"]
result = client.action(schema, action)

read

GET /api/materia/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this materia.

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action materia read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["materia", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["materia", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

medicine

list

GET /api/medicine/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`minItemLevel`
`maxItemLevel`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action medicine list -p minItemLevel=... -p maxItemLevel=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["medicine", "list"]
var params = {
    minItemLevel: ...,
    maxItemLevel: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["medicine", "list"]
params = {
    "minItemLevel": ...,
    "maxItemLevel": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/medicine/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this food.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`minItemLevel`
`maxItemLevel`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action medicine read -p id=... -p minItemLevel=... -p maxItemLevel=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["medicine", "read"]
var params = {
    id: ...,
    minItemLevel: ...,
    maxItemLevel: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["medicine", "read"]
params = {
    "id": ...,
    "minItemLevel": ...,
    "maxItemLevel": ...,
}
result = client.action(schema, action, params=params)

relic

list

GET /api/relic/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`baseItemId__itemLevel`
`itemLevelSync`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action relic list -p baseItemId__itemLevel=... -p itemLevelSync=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["relic", "list"]
var params = {
    baseItemId__itemLevel: ...,
    itemLevelSync: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["relic", "list"]
params = {
    "baseItemId__itemLevel": ...,
    "itemLevelSync": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/relic/

Create a new piece of relic.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`itemLevelSync`
`name` required
`param0Value`
`param1Value`
`param2Value`
`param3Value`
`param4Value`
`param5Value`
`baseItemId` required
`param0`
`param1`
`param2`
`param3`
`param4`
`param5`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action relic create -p itemLevelSync=... -p name=... -p param0Value=... -p param1Value=... -p param2Value=... -p param3Value=... -p param4Value=... -p param5Value=... -p baseItemId=... -p param0=... -p param1=... -p param2=... -p param3=... -p param4=... -p param5=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["relic", "create"]
var params = {
    itemLevelSync: ...,
    name: ...,
    param0Value: ...,
    param1Value: ...,
    param2Value: ...,
    param3Value: ...,
    param4Value: ...,
    param5Value: ...,
    baseItemId: ...,
    param0: ...,
    param1: ...,
    param2: ...,
    param3: ...,
    param4: ...,
    param5: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["relic", "create"]
params = {
    "itemLevelSync": ...,
    "name": ...,
    "param0Value": ...,
    "param1Value": ...,
    "param2Value": ...,
    "param3Value": ...,
    "param4Value": ...,
    "param5Value": ...,
    "baseItemId": ...,
    "param0": ...,
    "param1": ...,
    "param2": ...,
    "param3": ...,
    "param4": ...,
    "param5": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/relic/{id}/

Return a specific relic.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`baseItemId__itemLevel`
`itemLevelSync`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action relic read -p id=... -p baseItemId__itemLevel=... -p itemLevelSync=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["relic", "read"]
var params = {
    id: ...,
    baseItemId__itemLevel: ...,
    itemLevelSync: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["relic", "read"]
params = {
    "id": ...,
    "baseItemId__itemLevel": ...,
    "itemLevelSync": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/relic/{id}/

Update a specific relic.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`baseItemId__itemLevel`
`itemLevelSync`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`itemLevelSync`
`name` required
`param0Value`
`param1Value`
`param2Value`
`param3Value`
`param4Value`
`param5Value`
`baseItemId` required
`param0`
`param1`
`param2`
`param3`
`param4`
`param5`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action relic update -p id=... -p itemLevelSync=... -p name=... -p param0Value=... -p param1Value=... -p param2Value=... -p param3Value=... -p param4Value=... -p param5Value=... -p baseItemId=... -p param0=... -p param1=... -p param2=... -p param3=... -p param4=... -p param5=... -p baseItemId__itemLevel=... -p itemLevelSync=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["relic", "update"]
var params = {
    id: ...,
    itemLevelSync: ...,
    name: ...,
    param0Value: ...,
    param1Value: ...,
    param2Value: ...,
    param3Value: ...,
    param4Value: ...,
    param5Value: ...,
    baseItemId: ...,
    param0: ...,
    param1: ...,
    param2: ...,
    param3: ...,
    param4: ...,
    param5: ...,
    baseItemId__itemLevel: ...,
    itemLevelSync: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["relic", "update"]
params = {
    "id": ...,
    "itemLevelSync": ...,
    "name": ...,
    "param0Value": ...,
    "param1Value": ...,
    "param2Value": ...,
    "param3Value": ...,
    "param4Value": ...,
    "param5Value": ...,
    "baseItemId": ...,
    "param0": ...,
    "param1": ...,
    "param2": ...,
    "param3": ...,
    "param4": ...,
    "param5": ...,
    "baseItemId__itemLevel": ...,
    "itemLevelSync": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/relic/{id}/

Partial update a specific relic. WARNING: Untested.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`baseItemId__itemLevel`
`itemLevelSync`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`itemLevelSync`
`name`
`param0Value`
`param1Value`
`param2Value`
`param3Value`
`param4Value`
`param5Value`
`baseItemId`
`param0`
`param1`
`param2`
`param3`
`param4`
`param5`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action relic partial_update -p id=... -p itemLevelSync=... -p name=... -p param0Value=... -p param1Value=... -p param2Value=... -p param3Value=... -p param4Value=... -p param5Value=... -p baseItemId=... -p param0=... -p param1=... -p param2=... -p param3=... -p param4=... -p param5=... -p baseItemId__itemLevel=... -p itemLevelSync=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["relic", "partial_update"]
var params = {
    id: ...,
    itemLevelSync: ...,
    name: ...,
    param0Value: ...,
    param1Value: ...,
    param2Value: ...,
    param3Value: ...,
    param4Value: ...,
    param5Value: ...,
    baseItemId: ...,
    param0: ...,
    param1: ...,
    param2: ...,
    param3: ...,
    param4: ...,
    param5: ...,
    baseItemId__itemLevel: ...,
    itemLevelSync: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["relic", "partial_update"]
params = {
    "id": ...,
    "itemLevelSync": ...,
    "name": ...,
    "param0Value": ...,
    "param1Value": ...,
    "param2Value": ...,
    "param3Value": ...,
    "param4Value": ...,
    "param5Value": ...,
    "baseItemId": ...,
    "param0": ...,
    "param1": ...,
    "param2": ...,
    "param3": ...,
    "param4": ...,
    "param5": ...,
    "baseItemId__itemLevel": ...,
    "itemLevelSync": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/relic/{id}/

Delete a specific relic.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`baseItemId__itemLevel`
`itemLevelSync`

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action relic delete -p id=... -p baseItemId__itemLevel=... -p itemLevelSync=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["relic", "delete"]
var params = {
    id: ...,
    baseItemId__itemLevel: ...,
    itemLevelSync: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["relic", "delete"]
params = {
    "id": ...,
    "baseItemId__itemLevel": ...,
    "itemLevelSync": ...,
}
result = client.action(schema, action, params=params)

clone

GET /api/relic/{id}/clone/

Clone a specific relic.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://etro.gg/api/docs/

# Interact with the API endpoint
$ coreapi action relic clone -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["relic", "clone"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://etro.gg/api/docs/")

# Interact with the API endpoint
action = ["relic", "clone"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)