API

This chapter contains the developer reference documentation of the public API for django-eveuniverse consisting of all models, their manager methods and helpers.

Models

Models for Eve Universe.

class EveAncestry(*args, **kwargs)[source]

An ancestry in Eve Online

Parameters:

Relationship fields:

Parameters:

eve_bloodline (ForeignKey to EveBloodline) – Eve bloodline (related name: eve_bloodlines)

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

eve_bloodline

Type: ForeignKey to EveBloodline

Eve bloodline (related name: eve_bloodlines)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_bloodline_id

Internal field, use eve_bloodline instead.

icon_id

Type: PositiveIntegerField

Icon id

A wrapper for a deferred-loading field. When the value is read from this

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

short_description

Type: TextField

Short description

A wrapper for a deferred-loading field. When the value is read from this

class EveAsteroidBelt(*args, **kwargs)[source]

An asteroid belt in Eve Online

Parameters:
  • id (PositiveIntegerField) – Primary key: Id. Eve Online ID

  • name (CharField) – Name. Eve Online name

  • last_updated (DateTimeField) – Last updated. When this object was last updated from ESI

  • position_x (FloatField) – Position x. x position in the solar system

  • position_y (FloatField) – Position y. y position in the solar system

  • position_z (FloatField) – Position z. z position in the solar system

Relationship fields:

Parameters:

eve_planet (ForeignKey to EvePlanet) – Eve planet (related name: eve_asteroid_belts)

eve_planet

Type: ForeignKey to EvePlanet

Eve planet (related name: eve_asteroid_belts)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_planet_id

Internal field, use eve_planet instead.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.universe.EveAsteroidBeltManager object>
position_x

Type: FloatField

Position x. x position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_y

Type: FloatField

Position y. y position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_z

Type: FloatField

Position z. z position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

class EveBloodline(*args, **kwargs)[source]

A bloodline in Eve Online

Parameters:

Relationship fields:

Parameters:

Reverse relationships:

Parameters:

eve_bloodlines (Reverse ForeignKey from EveAncestry) – All eve bloodlines of this eve bloodline (related name of eve_bloodline)

charisma

Type: PositiveIntegerField

Charisma

A wrapper for a deferred-loading field. When the value is read from this

corporation_id

Type: PositiveIntegerField

Corporation id

A wrapper for a deferred-loading field. When the value is read from this

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

eve_bloodlines

Type: Reverse ForeignKey from EveAncestry

All eve bloodlines of this eve bloodline (related name of eve_bloodline)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_race

Type: ForeignKey to EveRace

Eve race (related name: eve_bloodlines)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_race_id

Internal field, use eve_race instead.

eve_ship_type

Type: ForeignKey to EveType

Eve ship type (related name: eve_bloodlines)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_ship_type_id

Internal field, use eve_ship_type instead.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

intelligence

Type: PositiveIntegerField

Intelligence

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

memory

Type: PositiveIntegerField

Memory

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

perception

Type: PositiveIntegerField

Perception

A wrapper for a deferred-loading field. When the value is read from this

willpower

Type: PositiveIntegerField

Willpower

A wrapper for a deferred-loading field. When the value is read from this

class EveCategory(*args, **kwargs)[source]

An inventory category in Eve Online

Parameters:

Reverse relationships:

Parameters:

eve_groups (Reverse ForeignKey from EveGroup) – All eve groups of this eve category (related name of eve_category)

eve_groups

Type: Reverse ForeignKey from EveGroup

All eve groups of this eve category (related name of eve_category)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

published

Type: BooleanField

Published

A wrapper for a deferred-loading field. When the value is read from this

class EveConstellation(*args, **kwargs)[source]

A star constellation in Eve Online

Parameters:
  • id (PositiveIntegerField) – Primary key: Id. Eve Online ID

  • name (CharField) – Name. Eve Online name

  • last_updated (DateTimeField) – Last updated. When this object was last updated from ESI

  • position_x (FloatField) – Position x. x position in the solar system

  • position_y (FloatField) – Position y. y position in the solar system

  • position_z (FloatField) – Position z. z position in the solar system

Relationship fields:

Parameters:

eve_region (ForeignKey to EveRegion) – Eve region (related name: eve_constellations)

Reverse relationships:

Parameters:

eve_solarsystems (Reverse ForeignKey from EveSolarSystem) – All eve solarsystems of this eve constellation (related name of eve_constellation)

classmethod eve_entity_category() str[source]

Return the EveEntity category of this model if one exists else an empty string.

eve_region

Type: ForeignKey to EveRegion

Eve region (related name: eve_constellations)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_region_id

Internal field, use eve_region instead.

eve_solarsystems

Type: Reverse ForeignKey from EveSolarSystem

All eve solarsystems of this eve constellation (related name of eve_constellation)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

position_x

Type: FloatField

Position x. x position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_y

Type: FloatField

Position y. y position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_z

Type: FloatField

Position z. z position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

class EveDogmaAttribute(*args, **kwargs)[source]

A dogma attribute in Eve Online

Parameters:

Relationship fields:

Parameters:

eve_unit (ForeignKey to EveUnit) – Eve unit (related name: eve_units)

Reverse relationships:

Parameters:
  • discharge_attribute_effects (Reverse ForeignKey from EveDogmaEffect) – All discharge attribute effects of this eve dogma attribute (related name of discharge_attribute)

  • duration_attribute_effects (Reverse ForeignKey from EveDogmaEffect) – All duration attribute effects of this eve dogma attribute (related name of duration_attribute)

  • falloff_attribute_effects (Reverse ForeignKey from EveDogmaEffect) – All falloff attribute effects of this eve dogma attribute (related name of falloff_attribute)

  • range_attribute_effects (Reverse ForeignKey from EveDogmaEffect) – All range attribute effects of this eve dogma attribute (related name of range_attribute)

  • tracking_speed_attribute_effects (Reverse ForeignKey from EveDogmaEffect) – All tracking speed attribute effects of this eve dogma attribute (related name of tracking_speed_attribute)

  • modified_attribute_modifiers (Reverse ForeignKey from EveDogmaEffectModifier) – All modified attribute modifiers of this eve dogma attribute (related name of modified_attribute)

  • modifying_attribute_modifiers (Reverse ForeignKey from EveDogmaEffectModifier) – All modifying attribute modifiers of this eve dogma attribute (related name of modifying_attribute)

  • eve_type_dogma_attributes (Reverse ForeignKey from EveTypeDogmaAttribute) – All eve type dogma attributes of this eve dogma attribute (related name of eve_dogma_attribute)

default_value

Type: FloatField

Default value

A wrapper for a deferred-loading field. When the value is read from this

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

discharge_attribute_effects

Type: Reverse ForeignKey from EveDogmaEffect

All discharge attribute effects of this eve dogma attribute (related name of discharge_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

display_name

Type: CharField

Display name

A wrapper for a deferred-loading field. When the value is read from this

duration_attribute_effects

Type: Reverse ForeignKey from EveDogmaEffect

All duration attribute effects of this eve dogma attribute (related name of duration_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_type_dogma_attributes

Type: Reverse ForeignKey from EveTypeDogmaAttribute

All eve type dogma attributes of this eve dogma attribute (related name of eve_dogma_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_unit

Type: ForeignKey to EveUnit

Eve unit (related name: eve_units)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_unit_id

Internal field, use eve_unit instead.

falloff_attribute_effects

Type: Reverse ForeignKey from EveDogmaEffect

All falloff attribute effects of this eve dogma attribute (related name of falloff_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

high_is_good

Type: BooleanField

High is good

A wrapper for a deferred-loading field. When the value is read from this

icon_id

Type: PositiveIntegerField

Icon id

A wrapper for a deferred-loading field. When the value is read from this

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

modified_attribute_modifiers

Type: Reverse ForeignKey from EveDogmaEffectModifier

All modified attribute modifiers of this eve dogma attribute (related name of modified_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

modifying_attribute_modifiers

Type: Reverse ForeignKey from EveDogmaEffectModifier

All modifying attribute modifiers of this eve dogma attribute (related name of modifying_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

published

Type: BooleanField

Published

A wrapper for a deferred-loading field. When the value is read from this

range_attribute_effects

Type: Reverse ForeignKey from EveDogmaEffect

All range attribute effects of this eve dogma attribute (related name of range_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

stackable

Type: BooleanField

Stackable

A wrapper for a deferred-loading field. When the value is read from this

tracking_speed_attribute_effects

Type: Reverse ForeignKey from EveDogmaEffect

All tracking speed attribute effects of this eve dogma attribute (related name of tracking_speed_attribute)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

class EveDogmaEffect(*args, **kwargs)[source]

A dogma effect in Eve Online

Parameters:

Relationship fields:

Parameters:

Reverse relationships:

Parameters:
  • modifiers (Reverse ForeignKey from EveDogmaEffectModifier) – All modifiers of this eve dogma effect (related name of eve_dogma_effect)

  • modifying_effect_modifiers (Reverse ForeignKey from EveDogmaEffectModifier) – All modifying effect modifiers of this eve dogma effect (related name of modifying_effect)

  • eve_type_dogma_effects (Reverse ForeignKey from EveTypeDogmaEffect) – All eve type dogma effects of this eve dogma effect (related name of eve_dogma_effect)

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

disallow_auto_repeat

Type: BooleanField

Disallow auto repeat

A wrapper for a deferred-loading field. When the value is read from this

discharge_attribute

Type: ForeignKey to EveDogmaAttribute

Discharge attribute (related name: discharge_attribute_effects)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
discharge_attribute_id

Internal field, use discharge_attribute instead.

display_name

Type: CharField

Display name

A wrapper for a deferred-loading field. When the value is read from this

duration_attribute

Type: ForeignKey to EveDogmaAttribute

Duration attribute (related name: duration_attribute_effects)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
duration_attribute_id

Internal field, use duration_attribute instead.

effect_category

Type: PositiveIntegerField

Effect category

A wrapper for a deferred-loading field. When the value is read from this

electronic_chance

Type: BooleanField

Electronic chance

A wrapper for a deferred-loading field. When the value is read from this

eve_type_dogma_effects

Type: Reverse ForeignKey from EveTypeDogmaEffect

All eve type dogma effects of this eve dogma effect (related name of eve_dogma_effect)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

falloff_attribute

Type: ForeignKey to EveDogmaAttribute

Falloff attribute (related name: falloff_attribute_effects)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
falloff_attribute_id

Internal field, use falloff_attribute instead.

icon_id

Type: PositiveIntegerField

Icon id

A wrapper for a deferred-loading field. When the value is read from this

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

is_assistance

Type: BooleanField

Is assistance

A wrapper for a deferred-loading field. When the value is read from this

is_offensive

Type: BooleanField

Is offensive

A wrapper for a deferred-loading field. When the value is read from this

is_warp_safe

Type: BooleanField

Is warp safe

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

modifiers

Type: Reverse ForeignKey from EveDogmaEffectModifier

All modifiers of this eve dogma effect (related name of eve_dogma_effect)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

modifying_effect_modifiers

Type: Reverse ForeignKey from EveDogmaEffectModifier

All modifying effect modifiers of this eve dogma effect (related name of modifying_effect)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

post_expression

Type: PositiveIntegerField

Post expression

A wrapper for a deferred-loading field. When the value is read from this

pre_expression

Type: PositiveIntegerField

Pre expression

A wrapper for a deferred-loading field. When the value is read from this

published

Type: BooleanField

Published

A wrapper for a deferred-loading field. When the value is read from this

range_attribute

Type: ForeignKey to EveDogmaAttribute

Range attribute (related name: range_attribute_effects)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
range_attribute_id

Internal field, use range_attribute instead.

range_chance

Type: BooleanField

Range chance

A wrapper for a deferred-loading field. When the value is read from this

tracking_speed_attribute

Type: ForeignKey to EveDogmaAttribute

Tracking speed attribute (related name: tracking_speed_attribute_effects)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
tracking_speed_attribute_id

Internal field, use tracking_speed_attribute instead.

class EveDogmaEffectModifier(*args, **kwargs)[source]

A modifier for a dogma effect in Eve Online

Parameters:

Relationship fields:

Parameters:
domain

Type: CharField

Domain

A wrapper for a deferred-loading field. When the value is read from this

eve_dogma_effect

Type: ForeignKey to EveDogmaEffect

Eve dogma effect (related name: modifiers)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_dogma_effect_id

Internal field, use eve_dogma_effect instead.

func

Type: CharField

Func

A wrapper for a deferred-loading field. When the value is read from this

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

modified_attribute

Type: ForeignKey to EveDogmaAttribute

Modified attribute (related name: modified_attribute_modifiers)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
modified_attribute_id

Internal field, use modified_attribute instead.

modifying_attribute

Type: ForeignKey to EveDogmaAttribute

Modifying attribute (related name: modifying_attribute_modifiers)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
modifying_attribute_id

Internal field, use modifying_attribute instead.

modifying_effect

Type: ForeignKey to EveDogmaEffect

Modifying effect (related name: modifying_effect_modifiers)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
modifying_effect_id

Internal field, use modifying_effect instead.

objects = <django.db.models.Manager object>
operator

Type: IntegerField

Operator

A wrapper for a deferred-loading field. When the value is read from this

class EveEntity(*args, **kwargs)[source]

An Eve object from one of the categories supported by ESI’s /universe/names/ endpoint:

alliance, character, constellation, faction, type, region, solar system, station

This is a special model model dedicated to quick resolution of Eve IDs to names and their categories, e.g. for characters. See also manager methods.

Parameters:
CATEGORY_ALLIANCE = 'alliance'
CATEGORY_CHARACTER = 'character'
CATEGORY_CHOICES = (('alliance', 'alliance'), ('character', 'character'), ('constellation', 'constellation'), ('corporation', 'corporation'), ('faction', 'faction'), ('inventory_type', 'inventory_type'), ('region', 'region'), ('solar_system', 'solar_system'), ('station', 'station'))
CATEGORY_CONSTELLATION = 'constellation'
CATEGORY_CORPORATION = 'corporation'
CATEGORY_FACTION = 'faction'
CATEGORY_INVENTORY_TYPE = 'inventory_type'
CATEGORY_REGION = 'region'
CATEGORY_SOLAR_SYSTEM = 'solar_system'
CATEGORY_STATION = 'station'
__init__(*args, **kwargs) None[source]
classmethod categories() Set[str][source]

Set of valid categories.

category

Type: CharField

Category

Choices:

  • alliance

  • character

  • constellation

  • corporation

  • faction

  • inventory_type

  • region

  • solar_system

  • station

A wrapper for a deferred-loading field. When the value is read from this

get_category_display(*, field=<django.db.models.CharField: category>)

Shows the label of the category. See get_FOO_display() for more information.

icon_url(size: int = 64) str[source]

Create image URL for related EVE icon

Parameters:

size – size of image file in pixels, allowed values: 32, 64, 128, 256, 512

Returns:

strings with image URL

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

property is_alliance: bool

returns True if entity is an alliance, else False

is_category(category: str) bool[source]

returns True if this entity has the given category, else False

property is_character: bool

returns True if entity is a character, else False

property is_constellation: bool

returns True if entity is a constellation, else False

property is_corporation: bool

returns True if entity is a corporation, else False

property is_faction: bool

returns True if entity is a faction, else False

property is_npc: bool

True if this entity is an NPC character or NPC corporation, else False.

property is_npc_starter_corporation: bool

True if this entity is an NPC starter corporation else False.

property is_region: bool

returns True if entity is a region, else False

property is_solar_system: bool

returns True if entity is a solar system, else False

property is_station: bool

returns True if entity is a station, else False

property is_type: bool

returns True if entity is an inventory type, else False

classmethod is_valid_category(category: str) bool[source]

Wether given category is valid.

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

objects = <django.db.models.manager.EveEntityManagerBaseFromEveEntityQuerySet object>
property profile_url: str

URL to default third party website with profile info about this entity.

Supported for: alliance, character, corporation, faction, region, solar system, station, type

update_from_esi() EveEntity[source]

Update the current object from ESI

Returns:

itself after update

class EveFaction(*args, **kwargs)[source]

A faction in Eve Online

Parameters:

Relationship fields:

Parameters:

eve_solar_system (ForeignKey to EveSolarSystem) – Eve solar system (related name: eve_factions)

corporation_id

Type: PositiveIntegerField

Corporation id

A wrapper for a deferred-loading field. When the value is read from this

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

classmethod eve_entity_category() str[source]

Return the EveEntity category of this model if one exists else an empty string.

eve_solar_system

Type: ForeignKey to EveSolarSystem

Eve solar system (related name: eve_factions)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_solar_system_id

Internal field, use eve_solar_system instead.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

is_unique

Type: BooleanField

Is unique

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

logo_url(size=64) str[source]

returns an image URL for this faction

Parameters:

size – optional size of the image

militia_corporation_id

Type: PositiveIntegerField

Militia corporation id

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

property profile_url: str

URL to default third party website with profile info about this entity.

size_factor

Type: FloatField

Size factor

A wrapper for a deferred-loading field. When the value is read from this

station_count

Type: PositiveIntegerField

Station count

A wrapper for a deferred-loading field. When the value is read from this

station_system_count

Type: PositiveIntegerField

Station system count

A wrapper for a deferred-loading field. When the value is read from this

class EveGraphic(*args, **kwargs)[source]

A graphic in Eve Online

Parameters:

Reverse relationships:

Parameters:

eve_types (Reverse ForeignKey from EveType) – All eve types of this eve graphic (related name of eve_graphic)

FILENAME_MAX_CHARS = 255
collision_file

Type: CharField

Collision file

A wrapper for a deferred-loading field. When the value is read from this

eve_types

Type: Reverse ForeignKey from EveType

All eve types of this eve graphic (related name of eve_graphic)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

graphic_file

Type: CharField

Graphic file

A wrapper for a deferred-loading field. When the value is read from this

icon_folder

Type: CharField

Icon folder

A wrapper for a deferred-loading field. When the value is read from this

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

sof_dna

Type: CharField

Sof dna

A wrapper for a deferred-loading field. When the value is read from this

sof_fation_name

Type: CharField

Sof fation name

A wrapper for a deferred-loading field. When the value is read from this

sof_hull_name

Type: CharField

Sof hull name

A wrapper for a deferred-loading field. When the value is read from this

sof_race_name

Type: CharField

Sof race name

A wrapper for a deferred-loading field. When the value is read from this

class EveGroup(*args, **kwargs)[source]

An inventory group in Eve Online

Parameters:

Relationship fields:

Parameters:

eve_category (ForeignKey to EveCategory) – Eve category (related name: eve_groups)

Reverse relationships:

Parameters:

eve_types (Reverse ForeignKey from EveType) – All eve types of this eve group (related name of eve_group)

eve_category

Type: ForeignKey to EveCategory

Eve category (related name: eve_groups)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_category_id

Internal field, use eve_category instead.

eve_types

Type: Reverse ForeignKey from EveType

All eve types of this eve group (related name of eve_group)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

published

Type: BooleanField

Published

A wrapper for a deferred-loading field. When the value is read from this

class EveIndustryActivity(*args, **kwargs)[source]

An industry activity in Eve Online.

Parameters:

Reverse relationships:

Parameters:
description

Type: CharField

Description

A wrapper for a deferred-loading field. When the value is read from this

eveindustryactivityduration_set

Type: Reverse ForeignKey from EveIndustryActivityDuration

All eve industry activity durations of this eve industry activity (related name of activity)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eveindustryactivitymaterial_set

Type: Reverse ForeignKey from EveIndustryActivityMaterial

All eve industry activity materials of this eve industry activity (related name of activity)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eveindustryactivityproduct_set

Type: Reverse ForeignKey from EveIndustryActivityProduct

All eve industry activity products of this eve industry activity (related name of activity)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eveindustryactivityskill_set

Type: Reverse ForeignKey from EveIndustryActivitySkill

All eve industry activity skills of this eve industry activity (related name of activity)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: IntegerField

Primary key: Id

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name

A wrapper for a deferred-loading field. When the value is read from this

objects = <django.db.models.Manager object>
class EveIndustryActivityDuration(*args, **kwargs)[source]

Number of seconds it takes to create a blueprint product.

Parameters:

Relationship fields:

Parameters:
activity

Type: ForeignKey to EveIndustryActivity

Activity (related name: eveindustryactivityduration)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
activity_id

Internal field, use activity instead.

eve_type

Type: ForeignKey to EveType

Eve type. Blueprint type (related name: industry_durations)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.sde.EveIndustryActivityDurationManager object>
time

Type: PositiveIntegerField

Time

A wrapper for a deferred-loading field. When the value is read from this

class EveIndustryActivityMaterial(*args, **kwargs)[source]

The materials and amounts required to create a blueprint product.

Parameters:

Relationship fields:

Parameters:
activity

Type: ForeignKey to EveIndustryActivity

Activity (related name: eveindustryactivitymaterial)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
activity_id

Internal field, use activity instead.

eve_type

Type: ForeignKey to EveType

Eve type. Blueprint type (related name: industry_materials)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

material_eve_type

Type: ForeignKey to EveType

Material eve type. Material required type (related name: +)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
material_eve_type_id

Internal field, use material_eve_type instead.

objects = <eveuniverse.managers.sde.EveIndustryActivityMaterialManager object>
quantity

Type: PositiveIntegerField

Quantity

A wrapper for a deferred-loading field. When the value is read from this

class EveIndustryActivityProduct(*args, **kwargs)[source]

Quantities of products for blueprints.

Parameters:

Relationship fields:

Parameters:
activity

Type: ForeignKey to EveIndustryActivity

Activity (related name: eveindustryactivityproduct)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
activity_id

Internal field, use activity instead.

eve_type

Type: ForeignKey to EveType

Eve type. Blueprint type (related name: industry_products)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.sde.EveIndustryActivityProductManager object>
product_eve_type

Type: ForeignKey to EveType

Product eve type. Result type (related name: +)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
product_eve_type_id

Internal field, use product_eve_type instead.

quantity

Type: PositiveIntegerField

Quantity

A wrapper for a deferred-loading field. When the value is read from this

class EveIndustryActivitySkill(*args, **kwargs)[source]

Levels of skills required for blueprint run.

Parameters:

Relationship fields:

Parameters:
activity

Type: ForeignKey to EveIndustryActivity

Activity (related name: eveindustryactivityskill)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
activity_id

Internal field, use activity instead.

eve_type

Type: ForeignKey to EveType

Eve type. Blueprint type (related name: industry_skills)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

level

Type: PositiveIntegerField

Level

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.sde.EveIndustryActivitySkillManager object>
skill_eve_type

Type: ForeignKey to EveType

Skill eve type. Skill book type (related name: +)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
skill_eve_type_id

Internal field, use skill_eve_type instead.

class EveMarketGroup(*args, **kwargs)[source]

A market group in Eve Online

Parameters:

Relationship fields:

Parameters:

parent_market_group (ForeignKey to EveMarketGroup) – Parent market group (related name: market_group_children)

Reverse relationships:

Parameters:
  • market_group_children (Reverse ForeignKey from EveMarketGroup) – All market group children of this eve market group (related name of parent_market_group)

  • eve_types (Reverse ForeignKey from EveType) – All eve types of this eve market group (related name of eve_market_group)

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

eve_types

Type: Reverse ForeignKey from EveType

All eve types of this eve market group (related name of eve_market_group)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

market_group_children

Type: Reverse ForeignKey from EveMarketGroup

All market group children of this eve market group (related name of parent_market_group)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

parent_market_group

Type: ForeignKey to EveMarketGroup

Parent market group (related name: market_group_children)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
parent_market_group_id

Internal field, use parent_market_group instead.

class EveMarketPrice(*args, **kwargs)[source]

A market price of an Eve Online type

Parameters:

Relationship fields:

Parameters:

eve_type (OneToOneField to EveType) – Primary key: Eve type (related name: market_price)

DEFAULT_MINUTES_UNTIL_STALE = 60
adjusted_price

Type: FloatField

Adjusted price

A wrapper for a deferred-loading field. When the value is read from this

average_price

Type: FloatField

Average price

A wrapper for a deferred-loading field. When the value is read from this

eve_type

Type: OneToOneField to EveType

Primary key: Eve type (related name: market_price)

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')
eve_type_id

Internal field, use eve_type instead.

get_next_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=True, **kwargs)

Finds next instance based on updated_at. See get_next_by_FOO() for more information.

get_previous_by_updated_at(*, field=<django.db.models.DateTimeField: updated_at>, is_next=False, **kwargs)

Finds previous instance based on updated_at. See get_previous_by_FOO() for more information.

objects = <eveuniverse.managers.universe.EveMarketPriceManager object>
updated_at

Type: DateTimeField

Updated at

A wrapper for a deferred-loading field. When the value is read from this

class EveMoon(*args, **kwargs)[source]

A moon in Eve Online

Parameters:
  • id (PositiveIntegerField) – Primary key: Id. Eve Online ID

  • name (CharField) – Name. Eve Online name

  • last_updated (DateTimeField) – Last updated. When this object was last updated from ESI

  • position_x (FloatField) – Position x. x position in the solar system

  • position_y (FloatField) – Position y. y position in the solar system

  • position_z (FloatField) – Position z. z position in the solar system

Relationship fields:

Parameters:

eve_planet (ForeignKey to EvePlanet) – Eve planet (related name: eve_moons)

eve_planet

Type: ForeignKey to EvePlanet

Eve planet (related name: eve_moons)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_planet_id

Internal field, use eve_planet instead.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.universe.EveMoonManager object>
position_x

Type: FloatField

Position x. x position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_y

Type: FloatField

Position y. y position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_z

Type: FloatField

Position z. z position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

class EvePlanet(*args, **kwargs)[source]

A planet in Eve Online

Parameters:
  • id (PositiveIntegerField) – Primary key: Id. Eve Online ID

  • name (CharField) – Name. Eve Online name

  • last_updated (DateTimeField) – Last updated. When this object was last updated from ESI

  • position_x (FloatField) – Position x. x position in the solar system

  • position_y (FloatField) – Position y. y position in the solar system

  • position_z (FloatField) – Position z. z position in the solar system

  • enabled_sections (BitField) – Enabled sections. Flags for loadable sections. True if instance was loaded with section.

Relationship fields:

Parameters:

Reverse relationships:

Parameters:
  • eve_asteroid_belts (Reverse ForeignKey from EveAsteroidBelt) – All eve asteroid belts of this eve planet (related name of eve_planet)

  • eve_moons (Reverse ForeignKey from EveMoon) – All eve moons of this eve planet (related name of eve_planet)

class Section(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Sections that can be optionally loaded with each instance

ASTEROID_BELTS = 'asteroid_belts'
MOONS = 'moons'
enabled_sections = ['asteroid_belts', 'moons']
eve_asteroid_belts

Type: Reverse ForeignKey from EveAsteroidBelt

All eve asteroid belts of this eve planet (related name of eve_planet)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_moons

Type: Reverse ForeignKey from EveMoon

All eve moons of this eve planet (related name of eve_planet)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_solar_system

Type: ForeignKey to EveSolarSystem

Eve solar system (related name: eve_planets)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_solar_system_id

Internal field, use eve_solar_system instead.

eve_type

Type: ForeignKey to EveType

Eve type (related name: eve_planets)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.universe.EvePlanetManager object>
position_x

Type: FloatField

Position x. x position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_y

Type: FloatField

Position y. y position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_z

Type: FloatField

Position z. z position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

type_name() str[source]

Return shortened name of planet type.

Note: Accesses the eve_type object.

class EveRace(*args, **kwargs)[source]

A race in Eve Online

Parameters:

Reverse relationships:

Parameters:
  • eve_bloodlines (Reverse ForeignKey from EveBloodline) – All eve bloodlines of this eve race (related name of eve_race)

  • eve_stations (Reverse ForeignKey from EveStation) – All eve stations of this eve race (related name of eve_race)

alliance_id

Type: PositiveIntegerField

Alliance id

A wrapper for a deferred-loading field. When the value is read from this

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

eve_bloodlines

Type: Reverse ForeignKey from EveBloodline

All eve bloodlines of this eve race (related name of eve_race)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_stations

Type: Reverse ForeignKey from EveStation

All eve stations of this eve race (related name of eve_race)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

class EveRegion(*args, **kwargs)[source]

A star region in Eve Online

Parameters:

Reverse relationships:

Parameters:

eve_constellations (Reverse ForeignKey from EveConstellation) – All eve constellations of this eve region (related name of eve_region)

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

eve_constellations

Type: Reverse ForeignKey from EveConstellation

All eve constellations of this eve region (related name of eve_region)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

classmethod eve_entity_category() str[source]

Return the EveEntity category of this model if one exists else an empty string.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

property profile_url: str

URL to default third party website with profile info about this entity.

class EveSolarSystem(*args, **kwargs)[source]

A solar system in Eve Online

Parameters:
  • id (PositiveIntegerField) – Primary key: Id. Eve Online ID

  • name (CharField) – Name. Eve Online name

  • last_updated (DateTimeField) – Last updated. When this object was last updated from ESI

  • position_x (FloatField) – Position x. x position in the solar system

  • position_y (FloatField) – Position y. y position in the solar system

  • position_z (FloatField) – Position z. z position in the solar system

  • security_status (FloatField) – Security status

  • enabled_sections (BitField) – Enabled sections. Flags for loadable sections. True if instance was loaded with section.

Relationship fields:

Parameters:

Reverse relationships:

Parameters:
  • eve_factions (Reverse ForeignKey from EveFaction) – All eve factions of this eve solar system (related name of eve_solar_system)

  • eve_planets (Reverse ForeignKey from EvePlanet) – All eve planets of this eve solar system (related name of eve_solar_system)

  • destination_eve_stargates (Reverse ForeignKey from EveStargate) – All destination eve stargates of this eve solar system (related name of destination_eve_solar_system)

  • eve_stargates (Reverse ForeignKey from EveStargate) – All eve stargates of this eve solar system (related name of eve_solar_system)

  • eve_stations (Reverse ForeignKey from EveStation) – All eve stations of this eve solar system (related name of eve_solar_system)

class NearestCelestial(eve_type, eve_object, distance)

Container for a nearest celestial

distance
eve_object
eve_type
class Section(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Sections that can be optionally loaded with each instance

PLANETS = 'planets'
STARGATES = 'stargates'
STARS = 'stars'
STATIONS = 'stations'
destination_eve_stargates

Type: Reverse ForeignKey from EveStargate

All destination eve stargates of this eve solar system (related name of destination_eve_solar_system)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

distance_to(destination: EveSolarSystem) float | None[source]

Calculates the distance in meters between the current and the given solar system

Parameters:

destination – Other solar system to use in calculation

Returns:

Distance in meters or None if one of the systems is in WH space

enabled_sections = ['planets', 'stargates', 'stars', 'stations']
eve_constellation

Type: ForeignKey to EveConstellation

Eve constellation (related name: eve_solarsystems)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_constellation_id

Internal field, use eve_constellation instead.

classmethod eve_entity_category() str[source]

Return related EveEntity category.

eve_factions

Type: Reverse ForeignKey from EveFaction

All eve factions of this eve solar system (related name of eve_solar_system)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_planets

Type: Reverse ForeignKey from EvePlanet

All eve planets of this eve solar system (related name of eve_solar_system)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_star

Type: OneToOneField to EveStar

Eve star (related name: eve_solarsystem)

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')
eve_star_id

Internal field, use eve_star instead.

eve_stargates

Type: Reverse ForeignKey from EveStargate

All eve stargates of this eve solar system (related name of eve_solar_system)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_stations

Type: Reverse ForeignKey from EveStation

All eve stations of this eve solar system (related name of eve_solar_system)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

property is_abyssal_deadspace: bool

Return True when this solar system is in abyssal deadspace, else False.

property is_high_sec: bool

Return True when this solar system is in high sec, else False.

property is_low_sec: bool

Return True when this solar system is in low sec, else False.

property is_null_sec: bool

Return True when this solar system is in null sec, else False.

is_trig_space
property is_w_space: bool

Return True when this solar system is in wormhole space, else False.

jumps_to(destination: EveSolarSystem) int | None[source]

Calculates the shortest route between the current and the given solar system

Parameters:

destination – Other solar system to use in calculation

Returns:

Number of total jumps or None if no route can be found (e.g. if one system is in WH space)

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

nearest_celestial(x: int, y: int, z: int, group_id: int | None = None) NearestCelestial | None[source]

Determine nearest celestial to given coordinates as eveuniverse object.

Parameters:
  • x – Start point in space to look from

  • y – Start point in space to look from

  • z – Start point in space to look from

  • group_id – Eve ID of group to filter results by

Raises:

HTTPError – If an HTTP error is encountered

Returns:

Eve item or None if none is found

position_x

Type: FloatField

Position x. x position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_y

Type: FloatField

Position y. y position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_z

Type: FloatField

Position z. z position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

property profile_url: str

Return URL to default third party website with profile info about this solar system.

route_to(destination: EveSolarSystem) List[EveSolarSystem] | None[source]

Calculates the shortest route between the current and the given solar system

Parameters:

destination – Other solar system to use in calculation

Returns:

List of solar system objects incl. origin and destination or None if no route can be found (e.g. if one system is in WH space)

security_status

Type: FloatField

Security status

A wrapper for a deferred-loading field. When the value is read from this

class EveStar(*args, **kwargs)[source]

A star in Eve Online

Parameters:

Relationship fields:

Parameters:

eve_type (ForeignKey to EveType) – Eve type (related name: eve_stars)

Reverse relationships:

Parameters:

eve_solarsystem (Reverse OneToOneField from EveSolarSystem) – The eve solarsystem of this eve star (related name of eve_star)

age

Type: BigIntegerField

Age

A wrapper for a deferred-loading field. When the value is read from this

eve_solarsystem

Type: Reverse OneToOneField from EveSolarSystem

The eve solarsystem of this eve star (related name of eve_star)

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')
eve_type

Type: ForeignKey to EveType

Eve type (related name: eve_stars)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

luminosity

Type: FloatField

Luminosity

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

radius

Type: PositiveIntegerField

Radius

A wrapper for a deferred-loading field. When the value is read from this

spectral_class

Type: CharField

Spectral class

A wrapper for a deferred-loading field. When the value is read from this

temperature

Type: PositiveIntegerField

Temperature

A wrapper for a deferred-loading field. When the value is read from this

class EveStargate(*args, **kwargs)[source]

A stargate in Eve Online

Parameters:
  • id (PositiveIntegerField) – Primary key: Id. Eve Online ID

  • name (CharField) – Name. Eve Online name

  • last_updated (DateTimeField) – Last updated. When this object was last updated from ESI

  • position_x (FloatField) – Position x. x position in the solar system

  • position_y (FloatField) – Position y. y position in the solar system

  • position_z (FloatField) – Position z. z position in the solar system

Relationship fields:

Parameters:

Reverse relationships:

Parameters:

evestargate (Reverse OneToOneField from EveStargate) – The eve stargate of this eve stargate (related name of destination_eve_stargate)

destination_eve_solar_system

Type: ForeignKey to EveSolarSystem

Destination eve solar system (related name: destination_eve_stargates)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
destination_eve_solar_system_id

Internal field, use destination_eve_solar_system instead.

destination_eve_stargate

Type: OneToOneField to EveStargate

Destination eve stargate (related name: evestargate)

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')
destination_eve_stargate_id

Internal field, use destination_eve_stargate instead.

eve_solar_system

Type: ForeignKey to EveSolarSystem

Eve solar system (related name: eve_stargates)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_solar_system_id

Internal field, use eve_solar_system instead.

eve_type

Type: ForeignKey to EveType

Eve type (related name: eve_stargates)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

evestargate

Type: Reverse OneToOneField from EveStargate

The eve stargate of this eve stargate (related name of destination_eve_stargate)

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')
id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.universe.EveStargateManager object>
position_x

Type: FloatField

Position x. x position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_y

Type: FloatField

Position y. y position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_z

Type: FloatField

Position z. z position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

class EveStation(*args, **kwargs)[source]

A space station in Eve Online

Parameters:
  • id (PositiveIntegerField) – Primary key: Id. Eve Online ID

  • name (CharField) – Name. Eve Online name

  • last_updated (DateTimeField) – Last updated. When this object was last updated from ESI

  • max_dockable_ship_volume (FloatField) – Max dockable ship volume

  • office_rental_cost (FloatField) – Office rental cost

  • owner_id (PositiveIntegerField) – Owner id

  • position_x (FloatField) – Position x. x position in the solar system

  • position_y (FloatField) – Position y. y position in the solar system

  • position_z (FloatField) – Position z. z position in the solar system

  • reprocessing_efficiency (FloatField) – Reprocessing efficiency

  • reprocessing_stations_take (FloatField) – Reprocessing stations take

Relationship fields:

Parameters:
classmethod eve_entity_category() str[source]

Return the EveEntity category of this model if one exists else an empty string.

eve_race

Type: ForeignKey to EveRace

Eve race (related name: eve_stations)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_race_id

Internal field, use eve_race instead.

eve_solar_system

Type: ForeignKey to EveSolarSystem

Eve solar system (related name: eve_stations)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_solar_system_id

Internal field, use eve_solar_system instead.

eve_type

Type: ForeignKey to EveType

Eve type (related name: eve_stations)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

max_dockable_ship_volume

Type: FloatField

Max dockable ship volume

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

office_rental_cost

Type: FloatField

Office rental cost

A wrapper for a deferred-loading field. When the value is read from this

owner_id

Type: PositiveIntegerField

Owner id

A wrapper for a deferred-loading field. When the value is read from this

position_x

Type: FloatField

Position x. x position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_y

Type: FloatField

Position y. y position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

position_z

Type: FloatField

Position z. z position in the solar system

A wrapper for a deferred-loading field. When the value is read from this

reprocessing_efficiency

Type: FloatField

Reprocessing efficiency

A wrapper for a deferred-loading field. When the value is read from this

reprocessing_stations_take

Type: FloatField

Reprocessing stations take

A wrapper for a deferred-loading field. When the value is read from this

services

Type: ManyToManyField to EveStationService

Services (related name: evestation)

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager

class EveStationService(*args, **kwargs)[source]

A service in a space station

Parameters:

Reverse relationships:

Parameters:

evestation (Reverse ManyToManyField from EveStation) – All eve stations of this eve station service (related name of services)

evestation_set

Type: Reverse ManyToManyField from EveStation

All eve stations of this eve station service (related name of services)

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name

A wrapper for a deferred-loading field. When the value is read from this

objects = <django.db.models.Manager object>
class EveType(*args, **kwargs)[source]

An inventory type in Eve Online

Parameters:

Relationship fields:

Parameters:

Reverse relationships:

Parameters:
class IconVariant(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Variant of icon to produce with icon_url()

BPC = 3
BPO = 2
REGULAR = 1
SKIN = 4
class Section(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Sections that can be optionally loaded with each instance

DOGMAS = 'dogmas'
GRAPHICS = 'graphics'
INDUSTRY_ACTIVITIES = 'industry_activities'
MARKET_GROUPS = 'market_groups'
TYPE_MATERIALS = 'type_materials'
capacity

Type: FloatField

Capacity

A wrapper for a deferred-loading field. When the value is read from this

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

dogma_attributes

Type: Reverse ForeignKey from EveTypeDogmaAttribute

All dogma attributes of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

dogma_effects

Type: Reverse ForeignKey from EveTypeDogmaEffect

All dogma effects of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

enabled_sections = ['dogmas', 'graphics', 'market_groups', 'type_materials', 'industry_activities']
eve_bloodlines

Type: Reverse ForeignKey from EveBloodline

All eve bloodlines of this eve type (related name of eve_ship_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

classmethod eve_entity_category() str[source]

Return the EveEntity category of this model if one exists else an empty string.

eve_graphic

Type: ForeignKey to EveGraphic

Eve graphic (related name: eve_types)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_graphic_id

Internal field, use eve_graphic instead.

eve_group

Type: ForeignKey to EveGroup

Eve group (related name: eve_types)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_group_id

Internal field, use eve_group instead.

eve_market_group

Type: ForeignKey to EveMarketGroup

Eve market group (related name: eve_types)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_market_group_id

Internal field, use eve_market_group instead.

eve_planets

Type: Reverse ForeignKey from EvePlanet

All eve planets of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_stargates

Type: Reverse ForeignKey from EveStargate

All eve stargates of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_stars

Type: Reverse ForeignKey from EveStar

All eve stars of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

eve_stations

Type: Reverse ForeignKey from EveStation

All eve stations of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

icon_id

Type: PositiveIntegerField

Icon id

A wrapper for a deferred-loading field. When the value is read from this

icon_url(size: int = 64, variant: IconVariant | None = None, category_id: int | None = None, is_blueprint: bool | None = None) str[source]

returns an image URL to this type as icon. Also works for blueprints and SKINs.

Will try to auto-detect the variant based on the types’s category, unless variant or category_id is specified.

Parameters:
  • variant – icon variant to use

  • category_id – category ID of this type

  • is_blueprint – DEPRECATED - type is assumed to be a blueprint

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

industry_durations

Type: Reverse ForeignKey from EveIndustryActivityDuration

All industry durations of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

industry_materials

Type: Reverse ForeignKey from EveIndustryActivityMaterial

All industry materials of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

industry_products

Type: Reverse ForeignKey from EveIndustryActivityProduct

All industry products of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

industry_skills

Type: Reverse ForeignKey from EveIndustryActivitySkill

All industry skills of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

market_price

Type: Reverse OneToOneField from EveMarketPrice

The market price of this eve type (related name of eve_type)

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')
mass

Type: FloatField

Mass

A wrapper for a deferred-loading field. When the value is read from this

material_types

Type: Reverse ForeignKey from EveTypeMaterial

All material types of this eve type (related name of material_eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

materials

Type: Reverse ForeignKey from EveTypeMaterial

All materials of this eve type (related name of eve_type)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

objects = <eveuniverse.managers.universe.EveTypeManager object>
packaged_volume

Type: FloatField

Packaged volume

A wrapper for a deferred-loading field. When the value is read from this

portion_size

Type: PositiveIntegerField

Portion size

A wrapper for a deferred-loading field. When the value is read from this

property profile_url: str

URL to display this type on the default third party webpage.

published

Type: BooleanField

Published

A wrapper for a deferred-loading field. When the value is read from this

radius

Type: FloatField

Radius

A wrapper for a deferred-loading field. When the value is read from this

render_url(size=64) str[source]

return an image URL to this type as render

volume

Type: FloatField

Volume

A wrapper for a deferred-loading field. When the value is read from this

class EveTypeDogmaAttribute(*args, **kwargs)[source]

A dogma attribute of on inventory type in Eve Online

Parameters:

Relationship fields:

Parameters:
eve_dogma_attribute

Type: ForeignKey to EveDogmaAttribute

Eve dogma attribute (related name: eve_type_dogma_attributes)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_dogma_attribute_id

Internal field, use eve_dogma_attribute instead.

eve_type

Type: ForeignKey to EveType

Eve type (related name: dogma_attributes)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

objects = <django.db.models.Manager object>
value

Type: FloatField

Value

A wrapper for a deferred-loading field. When the value is read from this

class EveTypeDogmaEffect(*args, **kwargs)[source]

A dogma effect of on inventory type in Eve Online

Parameters:

Relationship fields:

Parameters:
eve_dogma_effect

Type: ForeignKey to EveDogmaEffect

Eve dogma effect (related name: eve_type_dogma_effects)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_dogma_effect_id

Internal field, use eve_dogma_effect instead.

eve_type

Type: ForeignKey to EveType

Eve type (related name: dogma_effects)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

is_default

Type: BooleanField

Is default

A wrapper for a deferred-loading field. When the value is read from this

objects = <django.db.models.Manager object>
class EveTypeMaterial(*args, **kwargs)[source]

Material type for an Eve online type

Parameters:

Relationship fields:

Parameters:
eve_type

Type: ForeignKey to EveType

Eve type (related name: materials)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
eve_type_id

Internal field, use eve_type instead.

id

Type: AutoField

Primary key: ID

A wrapper for a deferred-loading field. When the value is read from this

material_eve_type

Type: ForeignKey to EveType

Material eve type (related name: material_types)

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')
material_eve_type_id

Internal field, use material_eve_type instead.

objects = <eveuniverse.managers.sde.EveTypeMaterialManager object>
quantity

Type: PositiveIntegerField

Quantity

A wrapper for a deferred-loading field. When the value is read from this

class EveUnit(*args, **kwargs)[source]

A unit in Eve Online

Parameters:

Reverse relationships:

Parameters:

eve_units (Reverse ForeignKey from EveDogmaAttribute) – All eve units of this eve unit (related name of eve_unit)

description

Type: TextField

Description

A wrapper for a deferred-loading field. When the value is read from this

display_name

Type: CharField

Display name

A wrapper for a deferred-loading field. When the value is read from this

eve_units

Type: Reverse ForeignKey from EveDogmaAttribute

All eve units of this eve unit (related name of eve_unit)

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager

id

Type: PositiveIntegerField

Primary key: Id. Eve Online ID

A wrapper for a deferred-loading field. When the value is read from this

last_updated

Type: DateTimeField

Last updated. When this object was last updated from ESI

A wrapper for a deferred-loading field. When the value is read from this

name

Type: CharField

Name. Eve Online name

A wrapper for a deferred-loading field. When the value is read from this

objects = <django.db.models.Manager object>

Managers

Managers and Querysets for EveEntity models.

class EveEntityManagerBase(*args, **kwargs)[source]

Custom manager for EveEntity

bulk_create_esi(ids: Iterable[int]) int[source]

Resolve given IDs from ESI and update or create corresponding objects.

DEPRECATED - please use bulk_resolve_ids() instead

Parameters:

ids – List of valid EveEntity IDs

Returns:

Count of updated entities

bulk_resolve_ids(ids: Iterable[int]) int[source]

Resolve given IDs from ESI and update or create corresponding objects.

Parameters:

ids – IDs to be resolved

Returns:

Count of updated entities

bulk_resolve_names(ids: Iterable[int]) EveEntityNameResolver[source]

Resolve given IDs to names and return them.

Parameters:

ids – List of valid EveEntity IDs

Returns:

EveEntityNameResolver object helpful for quick resolving a large amount of IDs

bulk_update_all_esi()[source]

Update all EveEntity objects in the database from ESI.

Returns:

Count of updated entities.

bulk_update_new_esi() int[source]

Update all unresolved EveEntity objects in the database from ESI.

Returns:

Count of updated entities.

fetch_by_names_esi(names: Iterable[str], update: bool = False) QuerySet[source]

Fetch entities matching given names. Will fetch missing entities from ESI if needed or requested.

Note that names that are not found by ESI are ignored.

Parameters:
  • names – Names of entities to fetch

  • update – When True will always update from ESI

Returns:

query with matching entities.

get_or_create_esi(*, id: int, include_children: bool = False, wait_for_children: bool = True, enabled_sections: Iterable[str] | None = None, task_priority: int | None = None) Tuple[Any, bool][source]

gets or creates an EvEntity object.

The object is automatically fetched from ESI if it does not exist (blocking) or if it has not yet been resolved.

Parameters:

id – Eve Online ID of object

Returns:

A tuple consisting of the requested EveEntity object and a created flag Returns a None objects if the ID is invalid

resolve_name(id: int) str[source]

Return the name for the given Eve entity ID or an empty string if ID is not valid.

update_from_esi_by_id(ids: Iterable[int]) int[source]

Updates all Eve entity objects by id from ESI.

update_or_create_all_esi(*, include_children: bool = False, wait_for_children: bool = True, enabled_sections: Iterable[str] | None = None, task_priority: int | None = None) None[source]

not implemented - do not use

update_or_create_esi(*, id: int, include_children: bool = False, wait_for_children: bool = True, enabled_sections: Iterable[str] | None = None, task_priority: int | None = None) Tuple[Any, bool][source]

Update or create an EveEntity object by fetching it from ESI (blocking).

Parameters:
  • id – Eve Online ID of object

  • include_children – (no effect)

  • wait_for_children – (no effect)

Returns:

A tuple consisting of the requested object and a created flag When the ID is invalid the returned object will be None

Exceptions:

Raises all HTTP codes of ESI endpoint /universe/names except 404

class EveEntityQuerySet(model=None, query=None, using=None, hints=None)[source]

Custom queryset for EveEntity.

update_from_esi() int[source]

Updates all Eve entity objects in this queryset from ESI.

Return count of updated objs.

valid_ids() Set[int][source]

Determine valid Ids in this Queryset.

Managers and Querysets for Eve universe models.

class EveIndustryActivityDurationManager(*args, **kwargs)[source]

Custom manager for EveIndustryActivityDuration.

update_or_create_api(*, eve_type) None[source]

Update or create objects from the API for the given eve type.

class EveIndustryActivityMaterialManager(*args, **kwargs)[source]

Custom manager for EveIndustryActivityMaterial.

update_or_create_api(*, eve_type) None[source]

Update or create objects from the API for the given eve type.

class EveIndustryActivityProductManager(*args, **kwargs)[source]

Custom manager for EveIndustryActivityProduct.

update_or_create_api(*, eve_type) None[source]

Update or create objects from the API for the given eve type.

class EveIndustryActivitySkillManager(*args, **kwargs)[source]

Custom manager for EveIndustryActivitySkill.

update_or_create_api(*, eve_type) None[source]

Update or create objects from the API for the given eve type.

class EveTypeMaterialManager(*args, **kwargs)[source]

Custom manager for EveTypeMaterial.

update_or_create_api(*, eve_type) None[source]

Update or create objects from the API for the given eve type.

Managers and Querysets for Eve universe models.

class EveMarketPriceManager(*args, **kwargs)[source]

Custom manager for EveMarketPrice.

fetch_data_from_esi() Dict[int, dict][source]

Fetch market prices from ESI and return them.

update_from_esi(minutes_until_stale: int | None = None) int[source]

Updates market prices from ESI. Will only create new price objects for EveTypes that already exist in the database.

Parameters:
  • minutes_until_stale – only prices older then given minutes are regarding

  • default (as stale and will be updated. Will use) –

Returns:

Count of updated types

update_objs_from_esi_data(prices: List[dict], minutes_until_stale: int | None = None) int[source]

Update prices from provided ESI data.

class EveUniverseEntityModelManager(*args, **kwargs)[source]

Custom manager adding the ability to fetch objects from ESI.

bulk_get_or_create_esi(*, ids: Iterable[int], include_children: bool = False, wait_for_children: bool = True, enabled_sections: Iterable[str] | None = None, task_priority: int | None = None) QuerySet[source]

Gets or creates objects in bulk.

Nonexisting objects will be fetched from ESI (blocking). Will always get/create parent objects.

Parameters:
  • ids – List of valid IDs of Eve objects

  • include_children – when needed to updated/created if child objects should be updated/created as well (if any)

  • wait_for_children – when true child objects will be updated/created blocking (if any), else async

  • enabled_sections – Sections to load regardless of current settings

Returns:

Queryset with all requested eve objects

get_or_create_esi(*, id: int, include_children: bool = False, wait_for_children: bool = True, enabled_sections: Iterable[str] | None = None, task_priority: int | None = None) Tuple[Any, bool][source]

gets or creates an eve universe object.

The object is automatically fetched from ESI if it does not exist (blocking). Will always get/create parent objects.

Parameters:
  • id – Eve Online ID of object

  • include_children – if child objects should be updated/created as well

  • created) ((only when a new object is) –

  • wait_for_children – when true child objects will be updated/created blocking

  • any) ((if) –

  • async (else) –

  • enabled_sections – Sections to load regardless of current settings,

  • EveTypes (e.g. [EveType.Section.DOGMAS] will always load dogmas for) –

  • task_priority – priority of started tasks

Returns:

A tuple consisting of the requested object and a created flag

update_or_create_all_esi(*, include_children: bool = False, wait_for_children: bool = True, enabled_sections: Iterable[str] | None = None, task_priority: int | None = None) None[source]

Update or create all objects of this class from ESI.

Loading all objects can take a long time. Use with care!

Parameters:
  • include_children – if child objects should be updated/created as well (if any)

  • wait_for_children – when false all objects will be loaded async, else blocking

  • enabled_sections – Sections to load regardless of current settings

update_or_create_esi(*, id: int, include_children: bool = False, wait_for_children: bool = True, enabled_sections: Iterable[str] | None = None, task_priority: int | None = None) Tuple[Any, bool][source]

updates or creates an Eve universe object by fetching it from ESI (blocking). Will always get/create parent objects

Parameters:
  • id – Eve Online ID of object

  • include_children – if child objects should be updated/created as well (if any)

  • wait_for_children – when true child objects will be updated/created blocking

  • any) ((if) –

  • async (else) –

  • enabled_sections – Sections to load regardless of current settings,

  • EveTypes (e.g. [EveType.Section.DOGMAS] will always load dogmas for) –

  • task_priority – priority of started tasks

Returns:

A tuple consisting of the requested object and a created flag

Helpers

Helper functions and classes for Eve Universe.

class EveEntityNameResolver(names_map: Dict[int, str])[source]

Container with a mapping between entity Ids and entity names and a performant API

__init__(names_map: Dict[int, str]) None[source]
to_name(id: int) str[source]

Resolved an entity ID to a name

Parameters:

id – ID of the Eve entity to resolve

Returns:

name for corresponding entity ID if known else an empty string

meters_to_au(value: float) float | None[source]

Convert meters into AU.

meters_to_ly(value: float) float | None[source]

Convert meters into lightyears.

Tasks

Eve Universe tasks

load_eve_object(model_name: str, id: int, include_children=False, wait_for_children=True) None[source]

Task for loading an eve object. Will only be created from ESI if it does not exist

update_or_create_eve_object(model_name: str, id: int, include_children=False, wait_for_children=True, enabled_sections: List[str] | None = None, task_priority: int | None = None) None[source]

Update or create an eve object from ESI.

Parameters:
  • model_name – Name of the respective Django model, e.g. "EveType"

  • id – Eve Online ID of object

  • include_children – if child objects should be updated/created as well

  • created) ((only when a new object is) –

  • wait_for_children – when true child objects will be updated/created blocking (if any),

  • async (else) –

  • enabled_sections – Sections to load regardless of current settings,

  • EveTypes (e.g. [EveType.Section.DOGMAS] will always load dogmas for) –

  • task_priority – priority of started tasks

EveEntity tasks

create_eve_entities(ids: Iterable[int]) None[source]

Task for bulk creating and resolving multiple entities from ESI.

update_unresolved_eve_entities() None[source]

Update all unresolved EveEntity objects from ESI.

Will resolve entities in parallel to speed up resolving large sets.

Object loader tasks

create_eve_entities(ids: Iterable[int]) None[source]

Task for bulk creating and resolving multiple entities from ESI.

update_unresolved_eve_entities() None[source]

Update all unresolved EveEntity objects from ESI.

Will resolve entities in parallel to speed up resolving large sets.

load_map(enabled_sections: List[str] | None = None) None[source]

Load the complete Eve map with all regions, constellation and solar systems and additional related entities if they are enabled.

Parameters:

enabled_sections – Sections to load regardless of current settings

load_all_types(enabled_sections: List[str] | None = None) None[source]

Load all eve types.

Parameters:

enabled_sections – Sections to load regardless of current settings

load_eve_types(category_ids: List[int] | None = None, group_ids: List[int] | None = None, type_ids: List[int] | None = None, force_loading_dogma: bool = False) None[source]

Load specified eve types from ESI. Will always load all children except for EveType

Args: - category_ids: EveCategory IDs - group_ids: EveGroup IDs - type_ids: EveType IDs - load_dogma: When True will load dogma for all types

Other tasks

update_market_prices(minutes_until_stale: int | None = None)[source]

Updates market prices from ESI.

Tools

Testdata

Tools for generating fixtures from production data for Eve Universe models.

class ModelSpec(model_name: str, ids: List[int], include_children: bool = False, enabled_sections: Iterable[str] | None = None)[source]

A ModelSpec class defines what objects are to be loaded as test data.

Parameters:
  • model_name – Name of Eve Universe model

  • ids – List of Eve IDs to be loaded

  • include_children – Whether to also load children of those objects

  • enabled_sections – Sections to load regardless of current settings, e.g. [EveType.Section.DOGMAS] will always load dogmas for EveTypes

enabled_sections: Iterable[str] | None
ids: List[int]
include_children: bool
model_name: str
create_testdata(spec: List[ModelSpec], filepath: str | Path) None[source]

Loads eve data from ESI as defined by spec and dumps it to file as JSON

Parameters:
  • spec – Specification of which Eve objects to load.

  • once. (The specification can contain the same model more than) –

  • filepath – absolute path of where to store the resulting JSON file

load_testdata_from_dict(testdata: dict) None[source]

Create eve objects in the database from testdata dump given as dict.

Parameters:

testdata – The dict containing the testdata as created by create_testdata()

load_testdata_from_file(filepath: str | Path) None[source]

Create eve objects in the database from testdata dump given as JSON file.

Parameters:
  • filepath – Absolute path to the JSON file containing the testdata

  • create_testdata() (created by) –

See also

Please also see Test data on how to create test data for your app.

Web APIs

APIs for accessing external web sites related to Eve Online.

dotlan

Generates profile URLs for dotlan.

alliance_url(name: str) str[source]

URL for page about given alliance on dotlan.

corporation_url(name: str) str[source]

URL for page about given corporation on dotlan.

faction_url(name: str) str[source]

URL for page about given corporation on dotlan.

region_url(name: str) str[source]

URL for page about given region on dotlan.

solar_system_url(name: str) str[source]

URL for page about given solar system on dotlan.

station_url(name: str) str[source]

URL for page about given solar system on dotlan.

esitools

Tools for interacting with ESI.

is_esi_online() bool[source]

Checks if the Eve servers are online. Returns True if there are, else False

eveimageserver

Fetching image URLs for Eve objects.

class EsiCategory(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum class for ESI categories

ALLIANCE = 1
CHARACTER = 2
CORPORATION = 3
FACTION = 4
TYPE = 5
class EsiTenant(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum class for ESI tenants

TRANQUILITY = 'tranquility'
class ImageVariant(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enum class for image variants

BPC = 'bpc'
BPO = 'bp'
ICON = 'icon'
PORTRAIT = 'portrait'
RENDER = 'render'
alliance_logo_url(alliance_id: int, size: int = 32) str[source]

image URL for the given alliance ID

character_portrait_url(character_id: int, size: int = 32) str[source]

image URL for the given character ID

corporation_logo_url(corporation_id: int, size: int = 32) str[source]

image URL for the given corporation ID

faction_logo_url(faction_id: int, size: int = 32) str[source]

image URL for the given alliance ID

type_bp_url(type_id: int, size: int = 32) str[source]

blueprint original image URL for the given type ID

type_bpc_url(type_id: int, size: int = 32) str[source]

blueprint copy image URL for the given type ID

type_icon_url(type_id: int, size: int = 32) str[source]

icon image URL for the given type ID

type_render_url(type_id: int, size: int = 32) str[source]

render image URL for the given type ID

eveitems

URLs for profile pages on eveitems webpage.

type_url(type_id: int) str[source]

URL to display any type on the default third party webpage.

evemicros

Wrapper to access evemicros API.

class EveItem(id: int, name: str, type_id: int, distance: float)[source]

A celestial item.

__init__(id: int, name: str, type_id: int, distance: float) None
distance: float
id: int
name: str
type_id: int
nearest_celestial(solar_system_id: int, x: int, y: int, z: int, group_id: int | None = None) EveItem | None[source]

Fetch nearest celestial to given coordinates from API. Results are cached.

Parameters:
  • solar_system_id – Eve ID of solar system

  • x – Start point in space to look from

  • y – Start point in space to look from

  • z – Start point in space to look from

  • group_id – Eve ID of group to filter results by

Raises:

HTTPError – If an HTTP error is encountered

Returns:

Found Eve item or None if nothing found nearby.

evesdeapi

Wrapper to access evesdeapi website.

class EveItem(id: int, name: str, type_id: int, distance: float)[source]

A celestial item.

__init__(id: int, name: str, type_id: int, distance: float) None
distance: float
classmethod from_dict(record: dict) EveItem[source]

Create new obj from a record.

id: int
name: str
type_id: int
nearest_celestial(solar_system_id: float, x: float, y: float, z: float, group_id: int | None = None) EveItem | None[source]

Fetch nearest celestial to given coordinates from API. Results are cached.

Parameters:
  • solar_system_id – Eve ID of solar system

  • x – Start point in space to look from

  • y – Start point in space to look from

  • z – Start point in space to look from

  • group_id – Eve ID of group to filter results by

Raises:

HTTPError – If an HTTP error is encountered

Returns:

Found Eve item or None if nothing found nearby.

eveskinserver

Wrapper for accessing eveskinserver API.

type_icon_url(type_id: int, size: int = 32) str[source]

icon image URL for the given SKIN type ID

evewho

Wrapper for generating profile URLs on evewho.

alliance_url(eve_id: int) str[source]

URL for page about given alliance on evewho.

character_url(eve_id: int) str[source]

URL for page about given character on evewho.

corporation_url(eve_id: int) str[source]

URL for page about given corporation on evewho.

evexml

Tools for dealing with eve data in XML.

Convert an eve style link into a normal URL.

Example: showinfo:5//30004984 => "https://evemaps.dotlan.net/system/Abune"

Supported variants:

Alliance, Character, Corporation, Inventory Type, Killmail, Solar System, Station and normal URLs

Returns:

Converted URL or an empty string if the link was invalid or not supported

is_url(url_string: str) bool[source]

True if given string is an URL, else False

remove_loc_tag(xml: str) str[source]

Remove all loc XML tags.

unicode_to_utf8(xml_doc: str) str[source]

Convert unicode encodings into UTF-8 characters.

zkillboard

Generates profile URLs for zKillboard.

alliance_url(eve_id: int) str[source]

url for page about given alliance on zKillboard

character_url(eve_id: int) str[source]

url for page about given character on zKillboard

corporation_url(eve_id: int) str[source]

url for page about given corporation on zKillboard

killmail_url(eve_id: int) str[source]

url for page about given kill on zKillboard

region_url(eve_id: int) str[source]

url for page about given region on zKillboard

solar_system_url(eve_id: int) str[source]

Return zKillboard URL for a solar system.