Inventory

The client.inventory resource lets you list and inspect entities — ships, vehicles, facilities, items, NPCs, and more — that belong to a character or a faction. The uid parameter on every method accepts either a character UID (e.g. 1:12345) or a faction UID (e.g. 20:123); the SDK does not have a separate client.faction.entities accessor — faction-owned entities are queried through this resource.

inventory.get()

Get inventory summary by UID. Returns the inventory summary object directly — not wrapped in a Page. Accepts either a character UID or a faction UID.

string

required

The uid parameter.

// Character inventory summary
const characterOverview = await client.inventory.get({ uid: '1:12345' });

// Faction inventory summary
const factionOverview = await client.inventory.get({ uid: '20:123' });
console.log(factionOverview); // access properties directly, not factionOverview.data

Entities

inventory.entities.addTag()

Add tag to entity

string

required

The entityType parameter.

string

required

The tag parameter.

string

required

The uid parameter.

inventory.entities.get()

Get a specific inventory entity by type and UID. Returns the entity object directly — not wrapped in a Page. The return type is narrowed by entityType, so entityType: 'npcs' yields an NpcEntityDetail with race, gender and level.

required

Entity type: ‘ships’, ‘vehicles’, ‘stations’, ‘cities’, ‘facilities’, ‘planets’, ‘items’, ‘npcs’, ‘droids’, ‘creatures’, or ‘materials’

string

required

Entity UID, e.g. “2:283”

const ship = await client.inventory.entities.get({ entityType: 'ships', uid: '2:283' });
console.log(ship.name);

// Actions are always an array, even when there is only one.
const facility = await client.inventory.entities.get({ entityType: 'facilities', uid: '4:3497164' });
for (const action of facility.actions?.action ?? []) {
  console.log(action.value.actiontype);
}

inventory.entities.list()

List entities in inventory (paginated with optional filtering) Supports filtering via filters (see the InventoryFilter type for value formats and API quirks). Filters are checked against the entity type before the request is sent. They are sent in a POST body, so a long list (for example hundreds of entity IDs) is not capped by the server’s URL limit. The uid argument accepts either a character UID (e.g. 1:12345) or a faction UID (e.g. 20:123) — there is no separate client.faction.entities accessor; faction-owned entities are queried through this method.

InventoryAssignType

required

Assignment type: ‘owner’, ‘commander’, or ‘pilot’

required

Entity type: ‘ships’, ‘vehicles’, ‘stations’, ‘cities’, ‘facilities’, ‘planets’, ‘items’, ‘npcs’, ‘droids’, ‘creatures’, or ‘materials’

**filter\_inclusion**: InventoryFilterInclusion[]

required

Use filters. One per entry in filter_type. Default: 'includes'

**filter\_type**: InventoryFilterType[]

required

Use filters. Filter types, one per value.

**filter\_value**: string[]

required

Use filters. One value per entry in filter_type.

InventoryFilter[]

Filters to apply. Filters of different types are combined with AND; several values for one type match any of them. Each type may appear once. Cannot be combined with the filter_type / filter_value / filter_inclusion arrays. Sent in a POST body, so the list is not limited by URL length.

**item\_count**: number

default:"50"

Number of items to retrieve. Default: 50, Max: 200

number

Milliseconds to wait before fetching each subsequent page. Helps avoid rate limits during auto-pagination.

**start\_index**: number

default:"1"

Starting position for pagination (1-based). Default: 1

string

required

Whose inventory: a character or faction UID (1:12345, 20:123) or their name.

// Character-owned ships
const myShips = await client.inventory.entities.list({ uid: '1:12345', entityType: 'ships', assignType: 'owner' });

// Faction-owned ships — pass a faction UID instead of a character UID
const factionShips = await client.inventory.entities.list({ uid: '20:123', entityType: 'ships', assignType: 'owner' });

// Faction facilities
const factionFacilities = await client.inventory.entities.list({ uid: '20:123', entityType: 'facilities', assignType: 'owner' });

// Vehicles a character is piloting
const pilotedVehicles = await client.inventory.entities.list({ uid: '1:12345', entityType: 'vehicles', assignType: 'pilot' });

// Fetch up to 200 entities at once
const moreEntities = await client.inventory.entities.list({ uid: '1:12345', entityType: 'vehicles', assignType: 'pilot', start_index: 1, item_count: 200 });

// Administered planets — note the assign type
const planets = await client.inventory.entities.list({ uid: '1:12345', entityType: 'planets', assignType: 'pilot' });

// Ships of either of two types that are not under construction
const ships = await client.inventory.entities.list({
  uid: '1:12345',
  entityType: 'ships',
  assignType: 'owner',
  filters: [
    { type: 'type', value: ['2:7', '2:19'] },
    { type: 'underconstruction', value: false },
  ],
});

// Ships not docked in any ship or station ("None" is `null`)
const undocked = await client.inventory.entities.list({
  uid: '1:12345',
  entityType: 'ships',
  assignType: 'owner',
  filters: [{ type: 'container', value: null }],
});

inventory.entities.removeAllTags()

Remove all tags from entity

string

required

The entityType parameter.

string

required

The uid parameter.

inventory.entities.removeTag()

Remove tag from entity

string

required

The entityType parameter.

string

required

The tag parameter.

string

required

The uid parameter.

inventory.entities.updateProperties()

Update a property on up to 100 entities in one request The API rejects the request as a whole if the client or the character lacks the permission for any of the entities. Otherwise, entities the change could not be applied to are listed under data.failed, with the reason.

string

required

New value, applied to every entity: - name: the new name (max 50 characters) - open-to: public, faction or none (any other value is treated as none) - owner, commander, pilot, crewlist-add, crewlist-remove: the name of the character or faction - infotext: the new text - action: resume, pause or abort - crewlist-clear: ignored, but a value must still be sent

InventoryEntityProperty

required

Property to update

string

Optional reason for the change. Only recorded when changing the owner, commander or pilot

string[]

required

UIDs of the entities to change (1 to 100). Entity types may be mixed

const result = await client.inventory.entities.updateProperties({
  property: 'commander',
  uids: ['2:1002', '3:2001'],
  new_value: 'Dax Orin',
});
console.log(result.data.succeeded.entity.map((entity) => entity.uid));
console.log(result.data.failed.entity);

inventory.entities.updateProperty()

Update entity property

string

required

Entity type (ships, vehicles, stations, etc.)

string

required

New value for the property

InventoryEntityProperty

required

Property to update

string

Optional reason for the change

string

required

Entity UID

Character

Access the character who owns or pilots these entities.

Faction

Access the faction whose entities you are listing.

Types

Look up entity type details and stats.

Location

Look up entity locations.

Get Started

Authentication

Core Concepts

API Resources

inventory.get()

Entities

inventory.entities.addTag()

inventory.entities.get()

inventory.entities.list()

inventory.entities.removeAllTags()

inventory.entities.removeTag()

inventory.entities.updateProperties()

inventory.entities.updateProperty()

Character

Faction

Types

Location

​inventory.get()

​Entities

​inventory.entities.addTag()

​inventory.entities.get()

​inventory.entities.list()

​inventory.entities.removeAllTags()

​inventory.entities.removeTag()

​inventory.entities.updateProperties()

​inventory.entities.updateProperty()

​Related resources

Character

Faction

Types

Location

inventory.get()

Entities

inventory.entities.addTag()

inventory.entities.get()

inventory.entities.list()

inventory.entities.removeAllTags()

inventory.entities.removeTag()

inventory.entities.updateProperties()

inventory.entities.updateProperty()

Related resources