Difference between revisions of "API access to market data"
From EVE University Wiki
m (Add link.) |
|||
| (14 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Out-of-game | + | {{Deprecated|Use [https://www.fuzzwork.co.uk/ Fuzzworks] or [https://evetycoon.com/ EVETycoon]}} |
| + | |||
| + | Out-of-game EVE data access is provided by CCP through the [[EVE Swagger Interface]] (ESI). However, this access method is not convenient for casual use. Fortunately, third-party services have arisen to provide better access for the casual player. EVE Market data can be accessed through an API provided by [https://api.evemarketer.com/ec/ EVEMarketer]. This service replaces a previous service provided by the defunct EVE Central. EVEMarketer API access methods are very similar to those used by EVE Central but different enough that previous calls will not work. These API calls can be used in a spreadsheet (e.g., Google Sheets, Excel) to provide programmatic access to Market Data even for casual users. | ||
== API Call construction == | == API Call construction == | ||
| − | + | [https://api.evemarketer.com/ec/ EVEMarketer] provides an endpoint accepting POST or GET methods and returns data in either XML (/marketstat) or JSON (/marketstat/json) formats. The call requires an item identifier (typeID) and has optional parameters to limit data to either a system (usesystem) or a region (regionlimit). A single call can contain up to 200 different items. By default, the data returned is XML and for all of Singularity. The following method describes how to use the GET access method. The GET call method produces a URL that can be directly entered into a web browser to provide data without any additional tools or knowledge. Users interested in the POST method should be able to construct the request given the GET method construction. | |
| − | [https://api.evemarketer.com/ec/ | ||
'''GET Examples''' | '''GET Examples''' | ||
| Line 15: | Line 16: | ||
=== Obtaining the typeID === | === Obtaining the typeID === | ||
| − | TypeIDs are unique identifiers specifying an item. There are several ways to get access to this information. Here are a few: | + | TypeIDs are unique identifiers specifying an item. There are several ways to get access to this information. Here are a few: |
| − | * [https://www.fuzzwork.co.uk/resources/typeids.csv | + | * Use CCP's ESI site. See [[How to get ID]] for details. |
| − | * [https://www.fuzzwork.co.uk/tools/api-typename-to-typeid/ | + | * Fuzzworks hosts a [https://www.fuzzwork.co.uk/resources/typeids.csv csv] containing all typeIDs and item names |
| − | * Most websites providing | + | * Fuzzworks hosts an [https://www.fuzzwork.co.uk/tools/api-typename-to-typeid/ API lookup for item names] |
| + | * Most websites providing EVE Market data use typeid to reference the specific examples ([https://evemarketer.com/types/215 EVE Marketer for Iron Charge S]) | ||
=== Obtaining the system and region IDs === | === Obtaining the system and region IDs === | ||
| − | The other two parameters, systemID and regionID are also unique identifiers specifying a singular region or solar system in | + | The other two parameters, systemID and regionID are also unique identifiers specifying a singular region or solar system in EVE. There are several ways to access this information. Here are a few: |
| − | * [https://www.adam4eve.eu/info_locations.php | + | * Use CCP's ESI site. See [[How to get ID]] for details. |
| + | * Adam4EVE hosts a [https://www.adam4eve.eu/info_locations.php list] | ||
* [https://docs.google.com/spreadsheets/d/1HkBZ_KvCYQeFf3awm91fmoPdHTBWugvVKpcwZUv7gXM Google Docs Spreadsheet] | * [https://docs.google.com/spreadsheets/d/1HkBZ_KvCYQeFf3awm91fmoPdHTBWugvVKpcwZUv7gXM Google Docs Spreadsheet] | ||
| − | * | + | * EVEMarketer can specify specific regions or systems. The identifier is available in the url.(Example: [https://evemarketer.com/regions/10000043/types/215 Iron Charge S in Domain]) |
* main trade hubs: Jita usesystem=30000142, Amarr usesystem=30002187, Rens usesystem=30002510, Dodixie usesystem=30002659 | * main trade hubs: Jita usesystem=30000142, Amarr usesystem=30002187, Rens usesystem=30002510, Dodixie usesystem=30002659 | ||
=== Constructing the GET API Call === | === Constructing the GET API Call === | ||
| − | Once you have a typeid and have chosen your area of interest (all of | + | Once you have a typeid and have chosen your area of interest (all of EVE, system, or region), you can place them into a call: |
* <nowiki>Basic call form: https://api.evemarketer.com/ec/marketstat?typeid=<typeid><®ionlimit=<regionid>|&usesystem=<systemid>></nowiki> | * <nowiki>Basic call form: https://api.evemarketer.com/ec/marketstat?typeid=<typeid><®ionlimit=<regionid>|&usesystem=<systemid>></nowiki> | ||
| − | * Example call for Iron Charge S for all | + | * Example call for Iron Charge S for all EVE data: https://api.evemarketer.com/ec/marketstat?typeid=215 |
The complete url can then be entered into a standard web browser, see above for further examples. | The complete url can then be entered into a standard web browser, see above for further examples. | ||
| Line 38: | Line 41: | ||
The returned data object contains Market Order information for both Buy and Sell orders. The relevant fields available are: | The returned data object contains Market Order information for both Buy and Sell orders. The relevant fields available are: | ||
* volume: Volume of buy or sell orders | * volume: Volume of buy or sell orders | ||
| − | * avg: Average buy or sell | + | * avg: Average buy or sell price |
| − | * max: Maximum buy or sell | + | * max: Maximum buy or sell price |
| − | * min: Minimum buy or sell | + | * min: Minimum buy or sell price |
| − | * stddev: Standard deviation of buy or sell | + | * stddev: Standard deviation of buy or sell prices |
| − | * median: Median buy or sell | + | * median: Median buy or sell price |
| − | * percentile: 95th percentile buy or sell | + | * percentile: 95th percentile buy or sell price |
| Line 49: | Line 52: | ||
The following instructions are for API calls in Google Sheets, but should be readily transferable to other spreadsheet programs (e.g., Excel). | The following instructions are for API calls in Google Sheets, but should be readily transferable to other spreadsheet programs (e.g., Excel). | ||
=== Google Sheets Method === | === Google Sheets Method === | ||
| − | Google Sheets uses the IMPORTXML function to make API calls and process XML. This function requires two parameters, the API URL and the XML field to retrieve. The API URL was constructed above (e.g., https://api.evemarketer.com/ec/marketstat?typeid= | + | Google Sheets uses the IMPORTXML function to make API calls and process XML. This function requires two parameters, the API URL and the XML field to retrieve. The API URL was constructed above (e.g., https://api.evemarketer.com/ec/marketstat?typeid=215). The XML fields available are described by the Data structure above and are specified by the form //<sell|buy>/<field>. The IMPORTXML function can be used in conjunction with cell functions (e.g., CONCATENATE, INDEX, LOOKUP, etc) to automate market data retrieval based on cell references. |
'''Examples''' | '''Examples''' | ||
| − | * <nowiki>=importxml("https://api.evemarketer.com/ec/marketstat?typeid= | + | * <nowiki>=importxml("https://api.evemarketer.com/ec/marketstat?typeid=215", "//buy/median") Median buy price for Iron Charge S </nowiki> |
| − | * <nowiki>=importxml("https://api.evemarketer.com/ec/marketstat?typeid= | + | * <nowiki>=importxml("https://api.evemarketer.com/ec/marketstat?typeid=215&usesystem=30000142", "//sell/min") Minimum sell price for Iron Charge S in Jita </nowiki> |
* <nowiki>=importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?typeid=", A1)), "//sell/volume") Volume of sell orders for the typeid in cell A1</nowiki> | * <nowiki>=importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?typeid=", A1)), "//sell/volume") Volume of sell orders for the typeid in cell A1</nowiki> | ||
* <nowiki>=importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?",typeid&JOIN(typeid,$B2:B201)), "//sell/median") Median sell price for each typeid provided in cells B2 through B201. Remember that the API limits you to 200 items per call.</nowiki> | * <nowiki>=importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?",typeid&JOIN(typeid,$B2:B201)), "//sell/median") Median sell price for each typeid provided in cells B2 through B201. Remember that the API limits you to 200 items per call.</nowiki> | ||
| − | * | + | * =importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?usesystem=30000142","&typeid="&JOIN("&typeid=",$B2:B201)), "//sell/median") Same as above except looking at Jita specifically and if you aren't using the named variables referenced in the Market Data Spreadsheet linked below. |
| − | |||
| − | |||
| − | |||
| − | |||
[[Category:Guides]] | [[Category:Guides]] | ||
[[Category:Trade]] | [[Category:Trade]] | ||
Latest revision as of 11:04, 4 December 2023
This article is deprecated and no longer in use.
Please visit Use Fuzzworks or EVETycoon for current info.
Please visit Use Fuzzworks or EVETycoon for current info.
Out-of-game EVE data access is provided by CCP through the EVE Swagger Interface (ESI). However, this access method is not convenient for casual use. Fortunately, third-party services have arisen to provide better access for the casual player. EVE Market data can be accessed through an API provided by EVEMarketer. This service replaces a previous service provided by the defunct EVE Central. EVEMarketer API access methods are very similar to those used by EVE Central but different enough that previous calls will not work. These API calls can be used in a spreadsheet (e.g., Google Sheets, Excel) to provide programmatic access to Market Data even for casual users.
Contents
API Call construction
EVEMarketer provides an endpoint accepting POST or GET methods and returns data in either XML (/marketstat) or JSON (/marketstat/json) formats. The call requires an item identifier (typeID) and has optional parameters to limit data to either a system (usesystem) or a region (regionlimit). A single call can contain up to 200 different items. By default, the data returned is XML and for all of Singularity. The following method describes how to use the GET access method. The GET call method produces a URL that can be directly entered into a web browser to provide data without any additional tools or knowledge. Users interested in the POST method should be able to construct the request given the GET method construction.
GET Examples
- https://api.evemarketer.com/ec/marketstat?typeid=215 returns the market data for Iron Charge S (typeid 215).
- https://api.evemarketer.com/ec/marketstat?typeid=215,216 returns the market data for Iron Charge S (typeid 215) and Tungsten Charge S (typeid 216).
- https://api.evemarketer.com/ec/marketstat?typeid=215&typeid=216 is an alternative form that also returns the market data for Iron Charge S (typeid 215) and Tungsten Charge S (typeid 216).
- https://api.evemarketer.com/ec/marketstat?typeid=215&usesystem=30000142 returns the market data for Iron Charge S (typeid 215) for Jita (usesystem 30000142)
- https://api.evemarketer.com/ec/marketstat?typeid=215®ionlimit=10000068 returns the market data for Iron Charge S (typeid 215) for Verge Vendor (regionlimit 10000068)
- https://api.evemarketer.com/ec/marketstat/json?typeid=215 returns the market data for Iron Charge S (typeid 215) in JSON format.
Obtaining the typeID
TypeIDs are unique identifiers specifying an item. There are several ways to get access to this information. Here are a few:
- Use CCP's ESI site. See How to get ID for details.
- Fuzzworks hosts a csv containing all typeIDs and item names
- Fuzzworks hosts an API lookup for item names
- Most websites providing EVE Market data use typeid to reference the specific examples (EVE Marketer for Iron Charge S)
Obtaining the system and region IDs
The other two parameters, systemID and regionID are also unique identifiers specifying a singular region or solar system in EVE. There are several ways to access this information. Here are a few:
- Use CCP's ESI site. See How to get ID for details.
- Adam4EVE hosts a list
- Google Docs Spreadsheet
- EVEMarketer can specify specific regions or systems. The identifier is available in the url.(Example: Iron Charge S in Domain)
- main trade hubs: Jita usesystem=30000142, Amarr usesystem=30002187, Rens usesystem=30002510, Dodixie usesystem=30002659
Constructing the GET API Call
Once you have a typeid and have chosen your area of interest (all of EVE, system, or region), you can place them into a call:
- Basic call form: https://api.evemarketer.com/ec/marketstat?typeid=<typeid><®ionlimit=<regionid>|&usesystem=<systemid>>
- Example call for Iron Charge S for all EVE data: https://api.evemarketer.com/ec/marketstat?typeid=215
The complete url can then be entered into a standard web browser, see above for further examples.
XML Market Data Structure
The returned data object contains Market Order information for both Buy and Sell orders. The relevant fields available are:
- volume: Volume of buy or sell orders
- avg: Average buy or sell price
- max: Maximum buy or sell price
- min: Minimum buy or sell price
- stddev: Standard deviation of buy or sell prices
- median: Median buy or sell price
- percentile: 95th percentile buy or sell price
Importing API Call into Spreadsheet
The following instructions are for API calls in Google Sheets, but should be readily transferable to other spreadsheet programs (e.g., Excel).
Google Sheets Method
Google Sheets uses the IMPORTXML function to make API calls and process XML. This function requires two parameters, the API URL and the XML field to retrieve. The API URL was constructed above (e.g., https://api.evemarketer.com/ec/marketstat?typeid=215). The XML fields available are described by the Data structure above and are specified by the form //<sell|buy>/<field>. The IMPORTXML function can be used in conjunction with cell functions (e.g., CONCATENATE, INDEX, LOOKUP, etc) to automate market data retrieval based on cell references.
Examples
- =importxml("https://api.evemarketer.com/ec/marketstat?typeid=215", "//buy/median") Median buy price for Iron Charge S
- =importxml("https://api.evemarketer.com/ec/marketstat?typeid=215&usesystem=30000142", "//sell/min") Minimum sell price for Iron Charge S in Jita
- =importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?typeid=", A1)), "//sell/volume") Volume of sell orders for the typeid in cell A1
- =importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?",typeid&JOIN(typeid,$B2:B201)), "//sell/median") Median sell price for each typeid provided in cells B2 through B201. Remember that the API limits you to 200 items per call.
- =importxml(CONCATENATE("https://api.evemarketer.com/ec/marketstat?usesystem=30000142","&typeid="&JOIN("&typeid=",$B2:B201)), "//sell/median") Same as above except looking at Jita specifically and if you aren't using the named variables referenced in the Market Data Spreadsheet linked below.
