API Cheat Sheet

From EVEDev

Jump to: navigation, search
API Urls
Generic Data
Map Data
Character List
Character Sheet
Account Journal
Transaction Data
Wallet Data
Member Tracking

Contents

[edit] Warning

This page has not been fully updated and/or is incomplete for the v2 API. All relevant data from this page will be moved to the API Reference page.

[edit] General Info

All parameters needed by the API are sent over HTTP POST, and should be html character encoded.

[edit] Authentication

All categories except 'Generic Data' and 'Map Data' need authentication. Authentication is done the same way as passing along parameters, which is through the POST method of a HTTP request. The following keys need to be sent to the API:

Key Type
userID integer / number
apiKey Alphanumeric string

The userID and apiKey for your own Eve account is available at http://myeve.eve-online.com/api/default.asp.

[edit] Character Sheet

All XML files in this category need the following keys:

Key Type
characterID integer / number


[edit] Account Data

All XML files in this category need the following keys:

Key Type
characterID integer / number
accountKey integer / number
beforeRefID integer / number


[edit] Transaction Data

All XML files in this category need the following keys:

Key Type
characterID integer / number
accountKey integer / number
beforeTransID integer / number


[edit] Wallet Data

All XML files in this category need the following keys:

Key Type
characterID integer / number


[edit] Wallet Journal

For the keys needed see Wallet Data heading.

[edit] Returned Data Explained

  • date ( Time ) - Time the action occured
  • ref_id ( Integer ) - Reference ID for this action (used with stepping through Journal Entries)
  • reftype_id ( Integer ) - RefType id
  • owner_name1 ( String ) - Name of the Player/Corporation/whatever that did something to owner_name2
  • owner_name2 ( String ) - Recipient of this action (from owner_name1)
  • owner_id1 ( Integer ) - ID of the Owner's whatever (Player/Corporation/Faction/Whatever)
  • owner_id2 ( Integer ) - ID of the recpient (Player/Corporation/Faction/Whatever)
  • arg_name1 ( String ) - For bounty, what caused this. (May be blank)
  • arg_id1 ( Integer ) - ID of arg_name1
  • amount ( Float ) - Balance changed by this amount
  • balance ( Float ) - New wallet balance after this action
  • reason ( String ) - Any reason for the action. May be blank (useful in giving ISK)



[edit] Member Tracking

All XML files in this category need the following keys:

Key Type
characterID integer / number
Retrieved from "http://wiki.eve-id.net/API_Cheat_Sheet"
Personal tools