EVE Echoes Trader
A cli based market data searching system utilizing data from https://eve-echoes-market.com/api
Report Bug
·
Request Feature
Table of Contents
Getting Started
To get a local copy up and running follow these simple steps.
back to topPrerequisites
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
Installation
- Clone the repo
git clone https://github.com/ironman9967/eve-echoes-trader.git
- Install NPM packages
npm install
Usage
Please note all commands are available via npm start
, just include the --
required by npm to pass parameters to the application. i.e. - npm start -- --help
Display Help
npx eve-echoes-trader --help
HTTP Server
npx eve-echoes-trader serve --port 8765
About
GET /api/about
- example response:
{ "appName": "eve-echoes-trader", "version": "1.0.1", "about": "eve-echoes-trader v1.0.1" }
Item Search
GET /api/item/search?term=[term to fuzzy search]
- example response for
term=veld
:
[
{
"id": 1552,
"terms": [
"veldspar"
],
"score": 29.209565298787776,
"match": {
"veldspar": [
"name"
]
},
"name": "Veldspar",
"itemId": "51000000000"
}
]
Item Names
GET /api/item/names
- example response for
term=veld
:
[ "Griffin", "Bantam", "Bantam II" ]
Item by Name
GET /api/item?name=[name to fuzzy search]
- example response for
name=veld
:
{
"headMeta": {
"_id": "5fc9b65c3e811fd806709dca",
"id": 0,
"lastDownload": {
"stamp": 1607054940244,
"duration": 150
}
},
"id": 1552,
"itemId": "51000000000",
"name": "Veldspar",
"statsMeta": {
"_id": "5fca92a9c0ab8d06ba41eab0",
"itemId": "51000000000",
"lastDownload": {
"stamp": 1607111337181,
"duration": 282
}
},
"aggregates": {
"time": {
"min": 1599555600,
"max": 1607097600,
"mean": 1602719045.7831326
},
"volume": {
"min": 2.63,
"max": 7.62,
"mean": 5.711277108433733
},
"sell": {
"min": 1599555600,
"max": 1607097600,
"mean": 1602719045.7831326
},
"lowestSell": {
"min": 1,
"max": 6,
"mean": 3.0289156626506024
},
"highestBuy": {
"min": 5,
"max": 17.14,
"mean": 7.149590361445781
},
"buy": {
"min": 4.24,
"max": 6.52,
"mean": 5.478024096385543
}
}
}
Item by ID
GET /api/item/[item ID]
- example response for
/api/item/51000000000
:
{
"headMeta": {
"_id": "5fc9b65c3e811fd806709dca",
"id": 0,
"lastDownload": {
"stamp": 1607054940244,
"duration": 150
}
},
"id": 1552,
"itemId": "51000000000",
"name": "Veldspar",
"statsMeta": {
"_id": "5fca92a9c0ab8d06ba41eab0",
"itemId": "51000000000",
"lastDownload": {
"stamp": 1607111337181,
"duration": 282
}
},
"aggregates": {
"time": {
"min": 1599555600,
"max": 1607097600,
"mean": 1602719045.7831326
},
"volume": {
"min": 2.63,
"max": 7.62,
"mean": 5.711277108433733
},
"sell": {
"min": 1599555600,
"max": 1607097600,
"mean": 1602719045.7831326
},
"lowestSell": {
"min": 1,
"max": 6,
"mean": 3.0289156626506024
},
"highestBuy": {
"min": 5,
"max": 17.14,
"mean": 7.149590361445781
},
"buy": {
"min": 4.24,
"max": 6.52,
"mean": 5.478024096385543
}
}
}
Item by ID Stats
GET /api/item/[item ID]/stats
- example response for
/api/item/51000000000/stats
:
{
"headMeta": {
"_id": "5fc9b65c3e811fd806709dca",
"id": 0,
"lastDownload": {
"stamp": 1607054940244,
"duration": 150
}
},
"id": 1552,
"itemId": "51000000000",
"name": "Veldspar",
"statsMeta": {
"_id": "5fca93b2c0ab8d06ba41f4b1",
"itemId": "51000000000",
"lastDownload": {
"stamp": 1607111602723,
"duration": 225
}
},
"aggregates": {
"time": {
"min": 1599555600,
"max": 1607097600,
"mean": 1602719045.7831326
},
"volume": {
"min": 2.63,
"max": 7.62,
"mean": 5.711277108433733
},
"sell": {
"min": 1599555600,
"max": 1607097600,
"mean": 1602719045.7831326
},
"lowestSell": {
"min": 1,
"max": 6,
"mean": 3.0289156626506024
},
"highestBuy": {
"min": 5,
"max": 17.14,
"mean": 7.149590361445781
},
"buy": {
"min": 4.24,
"max": 6.52,
"mean": 5.478024096385543
}
},
"stats": [
{
"itemId": "51000000000",
"time": 1599555600,
"sell": 6.22,
"buy": 6.38,
"lowestSell": 1,
"highestBuy": 7,
"volume": null
},
{
"itemId": "51000000000",
"time": 1599570000,
"sell": 6.15,
"buy": 6.52,
"lowestSell": 1,
"highestBuy": 8,
"volume": 5926117
}
]
}
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Your Name - @ledrugk - ironman9967@gmail.com
Project Link: https://github.com/ironman9967/eve-echoes-trader
back to top