Class: Killmail

Killmail

An api adapter over the end points handling killmail details via functions in the killmails ESI endpoints. You should not usually instantiate this directly as its constructor requires an internal api instance.

This is a function class so instances of Killmail are functions and can be invoked directly, besides accessing its members. Its default function action is equivalent to get.


new Killmail(agent)

Create a new Killmail function using the given agent.

Parameters:
Name Type Description
agent ESIAgent

The ESI agent

Methods


get(id, hash)

Return a single killmail from its ID and hash. This route is cached for up to 3600 seconds.

This makes an HTTP GET request to /killmails/{killmail_id}/{killmail_hash}/. The route version is v1.

On success, this resolves to a killmail. An example result is:

{
  "attackers": [
    {
      "alliance_id": 0,
      "character_id": 95810944,
      "corporation_id": 1000179,
      "damage_done": 5745,
      "faction_id": 500003,
      "final_blow": true,
      "security_status": -0.3,
      "ship_type_id": 17841,
      "weapon_type_id": 3074
    }
  ],
  "killmail_id": 56733821,
  "killmail_time": "2016-10-22T17:13:36Z",
  "moon_id": 0,
  "solar_system_id": 30002976,
  "victim": {
    "alliance_id": 621338554,
    "character_id": 92796241,
    "corporation_id": 841363671,
    "damage_taken": 5745,
    "faction_id": 0,
    "items": [
      {
        "flag": 20,
        "item_type_id": 5973,
        "items": [
          {
            "flag": 0,
            "item_type_id": 0,
            "quantity_destroyed": 0,
            "quantity_dropped": 0,
            "singleton": 0
          }
        ],
        "quantity_destroyed": 0,
        "quantity_dropped": 1,
        "singleton": 0
      }
    ],
    "position": {
      "x": 452186600569.4748,
      "y": 146704961490.90222,
      "z": 109514596532.54477
    },
    "ship_type_id": 17812
  },
  "war_id": 0
}
Parameters:
Name Type Description
id Number

The killmail ID to be queried.

hash String

The killmail hash for verification.

See:
Returns:

A Promise that resolves to the parsed JSON of the response.

Type
Promise.<Object>