Fleetyards.net API

API Schema for Fleetyards.net

https://api.fleetyards.net/v1/schema.yaml

Celestial Objects List

get
/celestial-objects

Get a List of Celestial Objects

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
cacheIdstringOptional
Responses
200

successful

application/json
get
/celestial-objects
200

successful

Celestial Object Detail

get
/celestial-objects/{slug}

Get Detail of a Celestial Object referenced by its Slug

Path parameters
slugstringRequired

slug

Responses
200

successful

application/json
get
/celestial-objects/{slug}
Deprecated

Commodity Types

get
/commodities/types
Responses
200

successful

application/json
get
/commodities/types
200

successful

Commodities list

get
/commodities
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 50
cacheIdstringOptional
Responses
200

successful

application/json
get
/commodities
200

successful

Create Commodity Price

post
/commodity-prices
Body
commodityItemIdstring · uuidRequired
commodityItemTypestringRequired
pathstring · enumRequiredPossible values:
shopIdstring · uuidRequired
timeRangestringOptional
Responses
200

successful

application/json
post
/commodity-prices
Deprecated

Commodity Types

get
/components/class_filters
Responses
200

successful

application/json
get
/components/class_filters
200

successful

Deprecated

Commodity Types

get
/components/item_type_filters
Responses
200

successful

application/json
get
/components/item_type_filters
200

successful

Components list

get
/components
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 50
cacheIdstringOptional
Responses
200

successful

application/json
get
/components
200

successful

Equipment list

get
/equipment
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 50
cacheIdstringOptional
Responses
200

successful

application/json
get
/equipment
200

successful

Feature Flags for User

get
/features
Responses
200

successful

application/json
Responsestring[]
get
/features
200

successful

Commodity Types

get
/filters/commodities/types
Responses
200

successful

application/json
get
/filters/commodities/types
200

successful

Commodity Types

get
/filters/commodity-prices/time-ranges
Responses
200

successful

application/json
get
/filters/commodity-prices/time-ranges
200

successful

Commodity Types

get
/filters/components/classes
Responses
200

successful

application/json
get
/filters/components/classes
200

successful

Commodity Types

get
/filters/components/item-types
Responses
200

successful

application/json
get
/filters/components/item-types
200

successful

Shop Commodity Commodity Type Options

get
/filters/shop-commodities/commodity-type-options
Responses
200

successful

application/json
get
/filters/shop-commodities/commodity-type-options
200

successful

Shop Commodity Sub Categories

get
/filters/shop-commodities/sub-categories
Responses
200

successful

application/json
get
/filters/shop-commodities/sub-categories
200

successful

Shop types

get
/filters/shops/types
Responses
200

successful

application/json
get
/filters/shops/types
200

successful

Check Fleet FID Availability

post
/fleets/check
Body
fidstringOptional
Responses
200

successful

application/json
post
/fleets/check

Create Fleet

post
/fleets
Body
fidstring · uuidRequired
namestringRequired
descriptionstringOptional
publicFleetbooleanOptional
homepagestringOptional
rsiSidstringOptional
discordstringOptional
tsstringOptional
youtubestringOptional
twitchstringOptional
guildedstringOptional
Responses
post
/fleets
Deprecated

Fleets for current User -> use GET /fleets/my

get
/fleets/current
Responses
200

successful

application/json
get
/fleets/current

Fleet Detail

get
/fleets/{slug}
Path parameters
slugstringRequired

slug

Responses
200

successful

application/json
get
/fleets/{slug}

Update Fleet

put
/fleets/{slug}

You are not an Admin or Officer of this Fleet

Path parameters
slugstringRequired

slug

Body
fidstringOptional
namestringOptional
logostring · binaryOptional
removeLogobooleanOptional
backgroundImagestring · binaryOptional
removeBackgroundbooleanOptional
descriptionstringOptional
publicFleetbooleanOptional
homepagestringOptional
rsiSidstringOptional
discordstringOptional
tsstringOptional
youtubestringOptional
twitchstringOptional
guildedstringOptional
Responses
200

successful

application/json
put
/fleets/{slug}

Destroy Fleet

delete
/fleets/{slug}

You are not the owner of this Fleet

Path parameters
slugstringRequired

slug

Responses
delete
/fleets/{slug}

No content

Find Fleet by Invite

post
/fleets/find-by-invite/{token}
Path parameters
tokenstringRequired

Fleet Invite Token

Responses
200

successful

application/json
post
/fleets/find-by-invite/{token}

Fleet Invite Urls List

get
/fleets/{fleetSlug}/invite-urls
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/invite-urls

Create Invite Url

post
/fleets/{fleetSlug}/invite-urls
Path parameters
fleetSlugstringRequired

Fleet slug

Body
limitintegerOptional
expiresAfterMinutesintegerOptional
Responses
post
/fleets/{fleetSlug}/invite-urls

Remove Invite Url

delete
/fleets/{fleetSlug}/invite-urls/{token}

You are not the owner of this Fleet

Path parameters
fleetSlugstringRequired

Fleet slug

tokenstringRequired

Invite Url Token

Responses
delete
/fleets/{fleetSlug}/invite-urls/{token}

No content

Create Membership by Invite

post
/fleets/use-invite

User is already a member of this fleet

Body
tokenstringOptional
Responses
post
/fleets/use-invite

Fleet Invites current User

get
/fleets/invites
Responses
200

successful

application/json
get
/fleets/invites

Accept Member

put
/fleets/{fleetSlug}/members/{username}/accept

No Member found

Path parameters
fleetSlugstringRequired

Fleet slug

usernamestringRequired

Username

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/{username}/accept

Fleet Member List

get
/fleets/{fleetSlug}/members
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
cacheIdstringOptional
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/members

Create Member

post
/fleets/{fleetSlug}/members

You are not the owner of this Fleet

Path parameters
fleetSlugstringRequired

Fleet slug

Body
usernamestringOptional
Responses
post
/fleets/{fleetSlug}/members
Deprecated

Update Membership -> use PUT /fleets/{fleetSlug}/membership

put
/fleets/{fleetSlug}/members
Path parameters
fleetSlugstringRequired

Fleet slug

Body
primarybooleanOptional
shipsFilterstring · enumOptionalPossible values:
Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members
200

successful

Decline Member

put
/fleets/{fleetSlug}/members/{username}/decline

No Member found

Path parameters
fleetSlugstringRequired

Fleet slug

usernamestringRequired

Username

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/{username}/decline

Demote Member

put
/fleets/{fleetSlug}/members/{username}/demote

No Member found

Path parameters
fleetSlugstringRequired

Fleet slug

usernamestringRequired

Username

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/{username}/demote
Deprecated

My Fleet Membership -> use GET /fleets/{fleetSlug}/membership

get
/fleets/{fleetSlug}/members/current
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/members/current
200

successful

Deprecated

Accept Member -> use GET /fleets/{fleetSlug}/members/{username}/accept

put
/fleets/{fleetSlug}/members/{username}/accept-request
Path parameters
fleetSlugstringRequired

Fleet slug

usernamestringRequired

Username

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/{username}/accept-request
200

successful

Deprecated

Decline Member -> use GET /fleets/{fleetSlug}/members/{username}/decline

put
/fleets/{fleetSlug}/members/{username}/decline-request
Path parameters
fleetSlugstringRequired

Fleet slug

usernamestringRequired

Username

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/{username}/decline-request
200

successful

Deprecated

Accept Membership -> use GET /fleets/{fleetSlug}/membership/accept

put
/fleets/{fleetSlug}/members/accept-invite
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/accept-invite
200

successful

Deprecated

Decline Membership -> use GET /fleets/{fleetSlug}/membership/decline

put
/fleets/{fleetSlug}/members/decline-invite
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/decline-invite
200

successful

Deprecated

Leave Fleet -> use DELETE /fleets/{fleetSlug}/membership

delete
/fleets/{fleetSlug}/members/leave
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
delete
/fleets/{fleetSlug}/members/leave
204

successful

No content

Remove Fleet Member

delete
/fleets/{fleetSlug}/members/{username}

You are not the owner of this Fleet

Path parameters
fleetSlugstringRequired

Fleet slug

usernamestringRequired

username

Responses
delete
/fleets/{fleetSlug}/members/{username}

No content

Promote Member

put
/fleets/{fleetSlug}/members/{username}/promote

No Member found

Path parameters
fleetSlugstringRequired

Fleet slug

usernamestringRequired

Username

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/members/{username}/promote

Accept Membership

put
/fleets/{fleetSlug}/membership/accept

No Membership found

Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/membership/accept

Decline Membership

put
/fleets/{fleetSlug}/membership/decline

No Membership found

Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
put
/fleets/{fleetSlug}/membership/decline

Fleet Membership Detail

get
/fleets/{fleetSlug}/membership

Membership for this slug and user does not exist

Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/membership

Update Membership

put
/fleets/{fleetSlug}/membership

Fleet for this slug and user does not exist

Path parameters
fleetSlugstringRequired

Fleet slug

Body
primarybooleanOptional
shipsFilterstring · enumOptionalPossible values:
Responses
200

successful

application/json
put
/fleets/{fleetSlug}/membership

Leave Fleet

delete
/fleets/{fleetSlug}/membership
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
delete
/fleets/{fleetSlug}/membership

No content

Fleets for current User

get
/fleets/my
Responses
200

successful

application/json
get
/fleets/my

Fleet Members Stats

get
/fleets/{fleetSlug}/stats/members
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/members
200

successful

Fleet Stats Model Counts

get
/fleets/{fleetSlug}/stats/model-counts
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/model-counts

Fleet Stats - Models by Classification

get
/fleets/{fleetSlug}/stats/models-by-classification
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/models-by-classification

Fleet Stats - Models by Manufacturer

get
/fleets/{fleetSlug}/stats/models-by-manufacturer
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/models-by-manufacturer

Fleet Stats - Models by Production Status

get
/fleets/{fleetSlug}/stats/models-by-production-status
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/models-by-production-status

Fleet Stats - Models by Size

get
/fleets/{fleetSlug}/stats/models-by-size
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/models-by-size

Fleet Stats - Vehicles by Model

get
/fleets/{fleetSlug}/stats/vehicles-by-model
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/vehicles-by-model

Fleet Vehicles Stats

get
/fleets/{fleetSlug}/stats/vehicles
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/stats/vehicles
200

successful

Deprecated

Fleet Public Vehicles -> use GET /fleets/{fleetSlug}/public/vehicles

get
/fleets/{fleetSlug}/public-vehicles
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/public-vehicles
200

successful

Deprecated

Fleet Fleetchart -> use GET /fleets/{fleetSlug}/vehicles

get
/fleets/{fleetSlug}/fleetchart
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

No content

get
/fleets/{fleetSlug}/fleetchart
200

successful

No content

Deprecated

Fleet Public Fleetchart -> use GET /fleets/{fleetSlug}/public/vehicles

get
/fleets/{fleetSlug}/public-fleetchart
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

No content

get
/fleets/{fleetSlug}/public-fleetchart
200

successful

No content

Deprecated

Fleet Vehicle QuickStats -> use GET /fleets/{fleetSlug}/stats/vehicles

get
/fleets/{fleetSlug}/quick-stats
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/fleets/{fleetSlug}/quick-stats
200

successful

Deprecated

Fleet Stats Model Counts -> use GET /fleets/{fleetSlug}/stats/model-counts

get
/fleets/{fleetSlug}/model-counts
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/model-counts
200

successful

Deprecated

Public Fleet Stats Model Counts -> use GET /public/fleets/{fleetSlug}/stats/model-counts

get
/fleets/{fleetSlug}/public-model-counts
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/public-model-counts
200

successful

Deprecated

Fleet Vehicles Embed for the Fleetyards Widget -> use GET /public/fleets/{fleetSlug}/vehicles/embed

get
/fleets/{fleetSlug}/embed
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/embed
200

successful

Fleet Vehicles List

get
/fleets/{fleetSlug}/vehicles/export
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/vehicles/export

Fleet Vehicles List

get
/fleets/{fleetSlug}/vehicles
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
groupedbooleanOptional
cacheIdstringOptional
Responses
200

successful

application/json
get
/fleets/{fleetSlug}/vehicles

Your personal Hangar

get
/hangar
Authorizations
FLTYRDstringRequired

Session Cookie

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/hangar

Clear your personal Hangar

delete
/hangar
Responses
delete
/hangar

No content

Export your personal Hangar

get
/hangar/export
Responses
200

successful

application/json
get
/hangar/export

HangarGroup list

get
/hangar/groups
Responses
200

successful

application/json
get
/hangar/groups

HangarGroup create

post
/hangar/groups
Body
namestringRequired
colorstringRequired
sortinteger | nullableOptional
publicboolean | nullableOptional
Responses
post
/hangar/groups

HangarGroup Update

put
/hangar/groups/{id}
Path parameters
idstring · uuidRequired

HangarGroup ID

Body
namestring | nullableOptional
colorstring | nullableOptional
sortinteger | nullableOptional
publicboolean | nullableOptional
Responses
200

successful

application/json
put
/hangar/groups/{id}

HangarGroup Destroy

delete
/hangar/groups/{id}
Path parameters
idstring · uuidRequired

HangarGroup ID

Responses
200

successful

application/json
delete
/hangar/groups/{id}

HangarGroup sort

put
/hangar/groups/sort
Responses
200

successful

application/json
put
/hangar/groups/sort

Import to your personal Hangar

put
/hangar/import
Body
stringOptional
Responses
200

successful

application/json
put
/hangar/import

Your personal Hangar items

get
/hangar/items
Responses
200

successful

application/json
Responsestring[]
get
/hangar/items

Move all Ingame Ships from your Hangar to your Wishlist

put
/hangar/move-all-ingame-to-wishlist
Responses
put
/hangar/move-all-ingame-to-wishlist

No content

Hangar Stats - Models by Classification

get
/hangar/stats/models-by-classification
Responses
200

successful

application/json
get
/hangar/stats/models-by-classification

Hangar Stats - Models by Manufacturer

get
/hangar/stats/models-by-manufacturer
Responses
200

successful

application/json
get
/hangar/stats/models-by-manufacturer

Hangar Stats - Models by Production Status

get
/hangar/stats/models-by-production-status
Responses
200

successful

application/json
get
/hangar/stats/models-by-production-status

Hangar Stats - Models by Size

get
/hangar/stats/models-by-size
Responses
200

successful

application/json
get
/hangar/stats/models-by-size

Your Hangar Stats

get
/hangar/stats
Query parameters
Responses
200

successful

application/json
get
/hangar/stats

Sync RSI Hangar

put
/hangar/sync-rsi-hangar
Body
Responses
200

successful

application/json
put
/hangar/sync-rsi-hangar
Deprecated

HangarGroup list

get
/hangar-groups
Responses
200

successful

application/json
get
/hangar-groups
Deprecated

HangarGroup create

post
/hangar-groups
Body
namestringRequired
colorstringRequired
sortinteger | nullableOptional
publicboolean | nullableOptional
Responses
post
/hangar-groups
Deprecated

HangarGroup Update

put
/hangar-groups/{id}
Path parameters
idstring · uuidRequired

HangarGroup ID

Body
namestring | nullableOptional
colorstring | nullableOptional
sortinteger | nullableOptional
publicboolean | nullableOptional
Responses
200

successful

application/json
put
/hangar-groups/{id}
Deprecated

HangarGroup Destroy

delete
/hangar-groups/{id}
Path parameters
idstring · uuidRequired

HangarGroup ID

Responses
200

successful

application/json
delete
/hangar-groups/{id}
Deprecated

HangarGroup sort

put
/hangar-groups/sort
Responses
200

successful

application/json
put
/hangar-groups/sort

Images list

get
/images
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
cacheIdstringOptional
Responses
200

successful

application/json
get
/images
200

successful

Images random list

get
/images/random

Get a randomized List of 14 Images

Query parameters
limitnumber · min: 1 · max: 30OptionalDefault: 14
Responses
200

successful

application/json
get
/images/random
200

successful

Deprecated

with_models manufacturer

get
/manufacturers/with-models
Responses
200

successful

application/json
get
/manufacturers/with-models
200

successful

Manufacturers list

get
/manufacturers
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
cacheIdstringOptional
Responses
200

successful

application/json
get
/manufacturers
200

successful

Model Paints List

get
/model-paints
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/model-paints
200

successful

Models with Docks

get
/models/with-docks
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

No content

get
/models/with-docks
200

successful

No content

Unscheduled Models

get
/models/unscheduled
Responses
200

successful

No content

get
/models/unscheduled
200

successful

No content

Latest Models

get
/models/latest
Responses
200

successful

No content

get
/models/latest
200

successful

No content

Available Model-Slugs

get
/models/slugs
Responses
200

successful

No content

get
/models/slugs
200

successful

No content

Updated Models

get
/models/updated
Query parameters
fromstring · datetimeOptional
tostring · datetimeOptionalDefault: now
Responses
200

successful

No content

get
/models/updated

No content

Embed Models

get
/models/embed
Responses
200

successful

No content

get
/models/embed
200

successful

No content

Model Filters

get
/models/filters
Responses
200

successful

application/json
get
/models/filters
200

successful

Model classifications

get
/models/classifications
Responses
200

successful

application/json
get
/models/classifications
200

successful

Model Production states

get
/models/production-states
Responses
200

successful

application/json
get
/models/production-states
200

successful

Model focus

get
/models/focus
Responses
200

successful

application/json
get
/models/focus
200

successful

Model Sizes

get
/models/sizes
Responses
200

successful

application/json
get
/models/sizes
200

successful

Model Cargo options

get
/models/cargo-options
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

No content

get
/models/cargo-options
200

successful

No content

Models List

get
/models
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
cacheIdstringOptional
Responses
200

successful

application/json
get
/models
200

successful

Model Detail

get
/models/{slug}
Path parameters
slugstringRequired

Model slug

Responses
200

successful

application/json
get
/models/{slug}

Model Hardpoints

get
/models/{slug}/hardpoints
Path parameters
slugstringRequired

Model slug

Query parameters
sourcestring · enumOptionalPossible values:
Responses
200

successful

application/json
get
/models/{slug}/hardpoints

Model Images

get
/models/{slug}/images
Path parameters
slugstringRequired

Model slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/models/{slug}/images

Model Videos

get
/models/{slug}/videos
Path parameters
slugstringRequired

Model slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 8
Responses
200

successful

application/json
get
/models/{slug}/videos

Model Variants

get
/models/{slug}/variants
Path parameters
slugstringRequired

Model slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/models/{slug}/variants

Model Loaners

get
/models/{slug}/loaners
Path parameters
slugstringRequired

Model slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/models/{slug}/loaners

Model Snubcrafts

get
/models/{slug}/snub-crafts
Path parameters
slugstringRequired

Model slug

Responses
200

successful

application/json
get
/models/{slug}/snub-crafts

Model Modules

get
/models/{slug}/modules
Path parameters
slugstringRequired

Model slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/models/{slug}/modules

Model Module Packages

get
/models/{slug}/module-packages
Path parameters
slugstringRequired

Model slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/models/{slug}/module-packages

Model Upgrades

get
/models/{slug}/upgrades
Path parameters
slugstringRequired

Model slug

Responses
200

successful

application/json
get
/models/{slug}/upgrades

Model Paints

get
/models/{slug}/paints
Path parameters
slugstringRequired

Model slug

Responses
200

successful

application/json
get
/models/{slug}/paints
Deprecated

Model Storeimage

get
/models/{slug}/store-image
Path parameters
slugstringRequired

Model slug

Responses
get
/models/{slug}/store-image
302

successful

No content

Deprecated

Model Fleetchart Image

get
/models/{slug}/fleetchart-image
Path parameters
slugstringRequired

Model slug

Responses
get
/models/{slug}/fleetchart-image

No content

Request Password reset

post
/password/request
Body
emailstringOptional
Responses
200

successful

application/json
post
/password/request

Update password

put
/password
Body
currentPasswordstringOptional
passwordstringOptional
passwordConfirmationstringOptional
Responses
200

successful

application/json
put
/password

Update Password with Token

put
/password/{token}
Path parameters
tokenstringRequired
Body
currentPasswordstringOptional
passwordstringOptional
passwordConfirmationstringOptional
Responses
200

successful

application/json
put
/password/{token}

Public Fleet Members Stats

get
/public/fleets/{fleetSlug}/stats/members
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/public/fleets/{fleetSlug}/stats/members

Public Fleet Stats Model Counts

get
/public/fleets/{fleetSlug}/stats/model-counts
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
Responses
200

successful

application/json
get
/public/fleets/{fleetSlug}/stats/model-counts

Public Fleet Vehicles Stats

get
/public/fleets/{fleetSlug}/stats/vehicles
Path parameters
fleetSlugstringRequired

Fleet slug

Responses
200

successful

application/json
get
/public/fleets/{fleetSlug}/stats/vehicles

Public Fleet Vehicles Embed for the Fleetyards Widget

get
/public/fleets/{fleetSlug}/vehicles/embed
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
Responses
200

successful

application/json
get
/public/fleets/{fleetSlug}/vehicles/embed

Public Fleet Vehicles List

get
/public/fleets/{fleetSlug}/vehicles
Path parameters
fleetSlugstringRequired

Fleet slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
groupedbooleanOptional
cacheIdstringOptional
Responses
200

successful

application/json
get
/public/fleets/{fleetSlug}/vehicles

Public Hangar embed

get
/public/hangars/embed
Query parameters
usernamesobject · HangarEmbedQueryRequired
Responses
200

empty response

application/json
get
/public/hangars/embed
200

empty response

HangarGroup list

get
/public/hangars/{username}/groups
Path parameters
usernamestringRequired

Username

Responses
200

successful

application/json
get
/public/hangars/{username}/groups
200

successful

Public Hangar

get
/public/hangars/{username}
Path parameters
usernamestringRequired
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/public/hangars/{username}

Public Hangar Stats

get
/public/hangars/{username}/stats
Path parameters
usernamestringRequired

username

Query parameters
Responses
200

successful

application/json
get
/public/hangars/{username}/stats

Your Wishlist

get
/public/wishlists/{username}
Path parameters
usernamestringRequired
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/public/wishlists/{username}

Roadmap Items

get
/roadmap
Query parameters
Responses
200

successful

application/json
get
/roadmap
200

successful

Roadmap Weeks

get
/roadmap/weeks
Responses
200

successful

application/json
get
/roadmap/weeks
200

successful

SC Data Version

get
/sc-data/version
Responses
200

successful

application/json
get
/sc-data/version
200

successful

get
/search
Query parameters
Responses
200

successful

application/json
get
/search
200

successful

confirm_access session

post
/sessions/confirm-access
Body
passwordstringRequired
Responses
200

successful

application/json
post
/sessions/confirm-access

create session

post
/sessions
Body
loginstringRequired

Username or email

passwordstringRequired
rememberMebooleanOptional
Responses
200

successful

application/json
post
/sessions

delete session

delete
/sessions
Responses
200

successful

No content

delete
/sessions

No content

Shop Commodity list

get
/stations/{stationSlug}/shops/{slug}/commodities
Path parameters
slugstringRequired
stationSlugstringRequired
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
searchstringOptional
cacheIdstringOptional
Responses
200

successful

application/json
get
/stations/{stationSlug}/shops/{slug}/commodities
Deprecated

Shop types

get
/shops/shop-types
Responses
200

successful

application/json
get
/shops/shop-types
200

successful

Shops list

get
/shops
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
cacheIdstringOptional
Responses
200

successful

application/json
get
/shops
200

successful

Shop Detail

get
/stations/{stationSlug}/shops/{slug}
Path parameters
stationSlugstringRequired

Station slug

slugstringRequired

Shop slug

Responses
200

successful

application/json
get
/stations/{stationSlug}/shops/{slug}

Starsystems list

get
/starsystems
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 15
cacheIdstringOptional
Responses
200

successful

application/json
get
/starsystems
200

successful

Starsystem Detail

get
/starsystems/{slug}
Path parameters
slugstringRequired

Starsystem slug

Responses
200

successful

application/json
get
/starsystems/{slug}

Station types

get
/stations/station-types
Responses
200

successful

application/json
get
/stations/station-types
200

successful

Station Ship sizes

get
/stations/ship-sizes
Responses
200

successful

application/json
get
/stations/ship-sizes
200

successful

Station classifications

get
/stations/classifications
Responses
200

successful

application/json
get
/stations/classifications
200

successful

Stations list

get
/stations
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 10
cacheIdstringOptional
Responses
200

successful

application/json
get
/stations
200

successful

Station Detail

get
/stations/{slug}
Path parameters
slugstringRequired

Station slug

Responses
200

successful

application/json
get
/stations/{slug}

Station Images

get
/stations/{slug}/images
Path parameters
slugstringRequired

Station slug

Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/stations/{slug}/images

Stats Components by Class

get
/stats/components-by-class
Responses
200

successful

application/json
get
/stats/components-by-class
200

successful

Stats Models by Classification

get
/stats/models-by-classification
Responses
200

successful

application/json
get
/stats/models-by-classification
200

successful

Stats Models by Manufacturer

get
/stats/models-by-manufacturer
Responses
200

successful

application/json
get
/stats/models-by-manufacturer
200

successful

Stats Models by Production-Status

get
/stats/models-by-production-status
Responses
200

successful

application/json
get
/stats/models-by-production-status
200

successful

Stats Models by Size

get
/stats/models-by-size
Responses
200

successful

application/json
get
/stats/models-by-size
200

successful

Stats Models per Month

get
/stats/models-per-month
Responses
200

successful

application/json
get
/stats/models-per-month
200

successful

Stats

get
/stats/quick-stats
Responses
200

successful

application/json
get
/stats/quick-stats
200

successful

Trade Routes

get
/trade-routes
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 50
cacheIdstringOptional
Responses
200

successful

application/json
get
/trade-routes
200

successful

Deprecated

My Data

get
/users/current
Responses
200

successful

application/json
get
/users/current
200

successful

My Data

get
/users/me
Responses
200

successful

application/json
get
/users/me

Update multiple vehicles

put
/vehicles/bulk
Body
idsstring · uuid[]Required
wantedboolean | nullableOptional
publicboolean | nullableOptional
hangarGroupIdsstring · uuid[] | nullableOptional
Responses
put
/vehicles/bulk

No content

Destroy multiple Vehicles

put
/vehicles/destroy-bulk
Body
idsstring · uuid[]Required
Responses
put
/vehicles/destroy-bulk

No content

Check Vehicle Serial

post
/vehicles/check-serial
Body
serialstringRequired
Responses
200

successful

application/json
post
/vehicles/check-serial
Deprecated

Vehicles List -> use GET /hangar

get
/vehicles
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/vehicles
200

successful

Create new Vehicle

post
/vehicles
Body
modelIdstring · uuidRequired
namestring | nullableOptional
serialstring | nullableOptional
wantedboolean | nullableOptional
nameVisibleboolean | nullableOptional
publicboolean | nullableOptional
saleNotifyboolean | nullableOptional
flagshipboolean | nullableOptional
modelPaintIdstring · uuid | nullableOptional
boughtViastring · enum | nullableOptionalPossible values:
hangarGroupIdsstring · uuid[] | nullableOptional
modelModuleIdsstring · uuid[] | nullableOptional
modelUpgradeIdsstring · uuid[] | nullableOptional
alternativeNamesstring[] | nullableOptional
Responses
post
/vehicles
Deprecated

Vehicle Fleetchart List -> use GET /hangar

get
/vehicles/fleetchart
Responses
200

successful

application/json
get
/vehicles/fleetchart
200

successful

Deprecated

Vehicle Export -> use GET /hangar/export

get
/vehicles/export
Responses
200

successful

application/json
get
/vehicles/export
200

successful

Deprecated

Vehicle import -> use PUT /hangar/import

put
/vehicles/import
Body
stringOptional
Responses
200

successful

application/json
put
/vehicles/import
200

successful

Deprecated

Vehicle Destroy all -> use DELETE /hangar

delete
/vehicles/destroy-all
Responses
delete
/vehicles/destroy-all
204

successful

No content

Deprecated

Vehicle embed -> use GET /public/hangar/embed

get
/vehicles/embed
Responses
200

successful

application/json
get
/vehicles/embed
200

successful

Deprecated

Vehicle Hangar items -> use GET /hangar/items

get
/vehicles/hangar-items
Responses
200

successful

application/json
Responsestring[]
get
/vehicles/hangar-items
200

successful

Deprecated

Vehicle hangar -> no replacement

get
/vehicles/hangar
Responses
200

successful

application/json
get
/vehicles/hangar
200

successful

Deprecated

Vehicle Quickstats -> use GET /hangar/stats

get
/vehicles/quick-stats
Responses
200

successful

No content

get
/vehicles/quick-stats
200

successful

No content

Deprecated

Vehicle Models by size -> use GET /hangar/stats/models-by-size

get
/vehicles/stats/models-by-size
Responses
200

successful

No content

get
/vehicles/stats/models-by-size
200

successful

No content

Deprecated

Vehicle Models by ProductionStatus -> use GET /hangar/stats/models-by-production-status

get
/vehicles/stats/models-by-production-status
Responses
200

successful

No content

get
/vehicles/stats/models-by-production-status
200

successful

No content

Deprecated

models_by_manufacturer vehicle

get
/vehicles/stats/models-by-manufacturer
Responses
200

successful

No content

get
/vehicles/stats/models-by-manufacturer
200

successful

No content

Deprecated

models_by_classification vehicle

get
/vehicles/stats/models-by-classification
Responses
200

successful

No content

get
/vehicles/stats/models-by-classification
200

successful

No content

Deprecated

public vehicle

get
/vehicles/{id}
Path parameters
idstring · uuidRequired

id

Responses
200

successful

application/json
get
/vehicles/{id}
200

successful

Update Vehicle

put
/vehicles/{id}
Path parameters
idstring · uuidRequired

id

Body
namestring | nullableOptional
serialstring | nullableOptional
wantedboolean | nullableOptional
nameVisibleboolean | nullableOptional
publicboolean | nullableOptional
saleNotifyboolean | nullableOptional
flagshipboolean | nullableOptional
modelPaintIdstring · uuid | nullableOptional
boughtViastring · enum | nullableOptionalPossible values:
hangarGroupIdsstring · uuid[] | nullableOptional
modelModuleIdsstring · uuid[] | nullableOptional
modelUpgradeIdsstring · uuid[] | nullableOptional
alternativeNamesstring[] | nullableOptional
Responses
200

successful

application/json
put
/vehicles/{id}

Delete Vehicle

delete
/vehicles/{id}
Path parameters
idstring · uuidRequired

id

Responses
200

successful

application/json
delete
/vehicles/{id}
Deprecated

public_fleetchart vehicle

get
/vehicles/{id}/fleetchart
Path parameters
idstringRequired

username

Responses
200

successful

application/json
get
/vehicles/{id}/fleetchart
200

successful

Deprecated

public_quick_stats vehicle

get
/vehicles/{id}/quick-stats
Path parameters
idstringRequired

username

Responses
200

successful

No content

get
/vehicles/{id}/quick-stats
200

successful

No content

Delete all ingame bought Vehicles

delete
/vehicles/destroy-all-ingame
Responses
delete
/vehicles/destroy-all-ingame

No content

Version of Fleetyards

get
/version
Responses
200

successful

application/json
get
/version
200

successful

Your Wishlist

get
/wishlist
Query parameters
pagestringOptionalDefault: 1
perPagestringOptionalDefault: 30
Responses
200

successful

application/json
get
/wishlist

Clear your Wishlist

delete
/wishlist
Responses
delete
/wishlist

No content

Export your Wishlist

get
/wishlist/export
Responses
200

successful

application/json
get
/wishlist/export

Your Wishlist items

get
/wishlist/items
Responses
200

successful

application/json
Responsestring[]
get
/wishlist/items

Last updated