Inara API

More about Inara API is on the API page, general dev guidelines are here and more detailed documentation about the events and data format here.

Just a note for tool authors using Inara API - please ensure your apps are doing  TWO requests per minute AT MAXIMUM. As I have discovered, many users are using multiple apps at once (nothing wrong with that), but are also updating their profiles from all of the applications at once, which is causing quite serious overhead. For such reason, I have needed to make API requests limits much tighter. For bots and other similar non-demanding apps are requests rates set same as before. If do you need another requests rate limit, please send me a PM.

Inara API update for Odyssey:
  • The header property isDeveloped was renamed to less confusing isBeingDeveloped. You don't need to change anything on your end though, the old property will still work.
  • A new event addCommanderTravelLand for commanders landing on the celestial body was added (should be triggered at journal's Touchdown, DropShipDeploy and similar).
  • The events addCommanderTravelCarrierJump, addCommanderTravelDock, addCommanderTravelFSDJump and setCommanderTravelLocation now contain optional properties for the star system coordinates, celestial body and celestial body coordinates. It's not required to set, it may however help to further precise commander's location when the star system is not in the database, etc.
  • The events addCommanderTravelDock, addCommanderTravelFSDJump and addCommanderTravelLand are now having boolean properties isTaxiShuttle and isTaxiDropship for travelling with Apex or Frontline Solutions ships.
  • New events setCommanderInventory, resetCommanderInventory, setCommanderInventoryItem, addCommanderInventoryItem and delCommanderInventoryItem added. Those are supposed for handling the new Odyssey events like ShipLockerMaterials and similar, you can however use it also for the existing engineering materials or ship cargo instead of the existing dedicated events (but you do not need to, they are not going anywhere).
  • New events setCommanderSuitLoadout, updateCommanderSuitLoadout and delCommanderSuitLoadout for the suit loadouts added.
Artie
02 Nov 2017, 7:52pm
Please place anything you would like to discuss, technical problems, questions about API, etc. right here...
FlynnRocks1556
02 Nov 2017, 8:03pm
Will the API directly plug ED data into the website thus eliminating the need to upload player journals?
Artie
02 Nov 2017, 8:31pm
FlynnRocks1556Will the API directly plug ED data into the website thus eliminating the need to upload player journals?

If it is meant in a way there will be possible to automatically get all the data from Frontier's server there - nope, there is no way how to do that.
But if it may replace the journals import? Yes, it can, when some app or existing app plugin will send the appropriate data.
User4296
02 Nov 2017, 8:45pm
Artie
FlynnRocks1556Will the API directly plug ED data into the website thus eliminating the need to upload player journals?


If it is meant in a way there will be possible to automatically get all the data from Frontier's server there - nope, there is no way how to do that.
But if it may replace the journals import? Yes, it can, when some app or existing app plugin will send the appropriate data.


So you're saying you'd like for someone to make something like, say, EDMC but for uploading to Inara directly, instead of having to pull from EDDB?
Artie
02 Nov 2017, 8:52pm
Not exactly, for example mrSheepSheep wrote a plugin for EDMC that is pushing some of the commander's data to Inara already. With this API it will be much easier and most importantly, more informations will be possible to send in (so it can basically replace the journal import, as it will be sending all the data on the fly). There is absolutely no intention to go around EDDN network which feeds Inara, EDDB, EDSM and other sites with galaxy data. I would like rather the opposite - more people using any app feeding EDDN is beneficiary for everybody.
User4296
02 Nov 2017, 8:55pm
That makes sense. More data is always a good thing. That said, congrats on the API beta rollout.
Bowersox
02 Nov 2017, 9:53pm
Is there a list of these somewhere?
  1. What the EDMC plugin pulls currently
  2. What the API supports currently
  3. What the API will eventually support

edit:lists
WALL-E-B
03 Nov 2017, 2:02am
BowersoxIs there a list of these somewhere?
  1. What the EDMC plugin pulls currently
  2. What the API supports currently
  3. What the API will eventually support

edit:lists

The source for the EDMC plugin that Mrsheep made is at https://gitlab.com/mrsheepsheep/EDMC-Inara - I have talked to him and am working on integrating the API into the plugin
MrSheepSheep
03 Nov 2017, 3:00am
BowersoxIs there a list of these somewhere?
  1. What the EDMC plugin pulls currently
  2. What the API supports currently
  3. What the API will eventually support

edit:lists


At first, the plugin was updating your location, credits and rank status on your profile on every EDMC "update".
The API currently supports what the plugin is already able to send (location, credits, ranks), and I'll implement it asap and as new methods are added.
The most interesting part will concern the shipyard and inventory, even though the journal import is already doing its job pretty well.

Edit: ok so here is my first implementation in python: https://gitlab.com/snippets/1682497
(Duuh those None checks)

Last edit: 03 Nov 2017, 5:35am
Greno Zee
03 Nov 2017, 11:13am
Hi Artie and congrats, great job!
If I may ask, do you have plans on providing data through your API? Namely, I really would love the possibility to pull list of missions available.
The reason, quite a number of our wing members don't speak english so Inara, while great tool, is unusable for them. I'm working on a EDMarketConnector plugin that would show a list of available missions. Current plans are to implement our own mission back-end but I have high hopes for Inara being able to provide
Artie
03 Nov 2017, 11:46am
MrSheepSheep: Perfect!

Greno: Yes, I have plans to include also some wing stuff in there. It will be added later.
CMDR_KODIAK
03 Nov 2017, 2:35pm
I started using your new plug in yesterday and it working like a charm, great job
Martind Forlon
03 Nov 2017, 5:06pm
Added one suggestion for MrSheepSheep EDMC plugin: https://gitlab.com/mrsheepsheep/EDMC-Inara/issues/5

Hi, could be possible in the next version (with Inara API) make changes to the way how are recorded credits/assets? Atm plugin doing entry into credits/assets on each dock and it makes cmdr financial overview very spammed. It would be great if these record would be done only once per session, or if each cmdr can set this as option. Thx for your work on this plugin.
Phelbore
03 Nov 2017, 5:12pm
Martind ForlonAdded one suggestion for MrSheepSheep EDMC plugin: https://gitlab.com/mrsheepsheep/EDMC-Inara/issues/5

Hi, could be possible in the next version (with Inara API) make changes to the way how are recorded credits/assets? Atm plugin doing entry into credits/assets on each dock and it makes cmdr financial overview very spammed. It would be great if these record would be done only once per session, or if each cmdr can set this as option. Thx for your work on this plugin.


I'd rather it be an option, I like the granularity myself, but I can see why people would want a... zoomed-out? view.
Artie
03 Nov 2017, 5:24pm
I recommended in the API documentation to not update credits too often, on each minor credits change (for example like picking up the bounties, one by one, etc.). A good way may be on the session end/start, big changes and/or in hourly intervals. Otherwise it may cause too much clutter in the credits log for the player and it simply may become unusable from the user's point of view. But, it is a decision of each API user/developer, of course.

Post a reply

You must be signed in to post here.
Inara API is... well... see sticky post for the details.