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 by various entity properties. Filter arrays must have matching lengths. 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[]

Whether each filter should include or exclude matches. Default: ‘includes’

**filter\_type**: InventoryFilterType[]

Filter types to apply to the query

**filter\_value**: string[]

Values corresponding to each filter type

**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

The uid parameter.

// 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' });

// Filter by multiple criteria
const multiFiltered = await client.inventory.entities.list({
  uid: '1:12345',
  entityType: 'ships',
  assignType: 'owner',
  filter_type: ['class', 'powered'],
  filter_value: ['Fighter', '1'],
  filter_inclusion: ['includes', 'includes']
});

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.updateProperty()

Update entity property

string

required

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

string

required

New value for the property

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.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.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.updateProperty()

Related resources