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
11 Nov 2017, 12:33pm
Another 'polishing' pass was made:
- events addCommanderTravelDock, addCommanderTravelFSDJump and setCommanderTravelLocation now returns starsystem/station IDs as are on Inara (when known), together with URLs to respective pages here.
- events addCommanderShip, setCommanderShip and setCommanderShipDock returns ship IDs as are on Inara, also with URL.
MrSheepSheep
11 Nov 2017, 7:44pm
Otis B.MrSheepSheep can you confg.set(‘inara_out’, 0) in your plugin_start() and prefs_changed() if the user has enabled any of your output options, to ensure that data isn’t sent to Inara twice.

Roger that. Thanks for adding it !
Lekeno
11 Nov 2017, 11:52pm
Artie, would it be possible to have an exact match option for getcmdrprofile, or at least a case insensitive "exact" match (I believe that Elite cmdrs are case insensitive unique)?
Artie
12 Nov 2017, 12:03am
It is already working that way - there is case insensitive exact match against in-game CMDR names made first. When nothing found, the name is searched in Inara user names (like%), the first result is then returned (when it is an exact match, it should be also that result). But bear in mind that there is around 90k users registered, which is still less than 10% of the entire playerbase. So there is very probable that nothing will be found.

Last edit: 12 Nov 2017, 12:10am
Lekeno
12 Nov 2017, 1:21am
Thanks for the details. Hopefully, these 10% include the most active players
Artie
12 Nov 2017, 1:07pm
Minor changes:
- 'starsystemName' and 'stationName' properties were added to the 'setCommanderShip', you can eventually use that for the dock location.
- 'setCommanderShipDock' was renamed to 'setCommanderShipTransfer', as it will be probably used just for that (but the previous event name was kept as alias for now, so everything is still working when already implemented)
Silver Taffer
12 Nov 2017, 7:10pm
Hi Artie. Firstly, many thanks for this amazing site and the work that makes it so o7

Second, is the API an alternative to the current log file downloads or is it a replacement? I don’t know if I need to download the app or not?
Artie
12 Nov 2017, 7:12pm
It is an alternative, the journal import won't be removed. So it is entirely your choice which method do you want to use.
Silver Taffer
12 Nov 2017, 8:31pm
ArtieIt is an alternative, the journal import won't be removed. So it is entirely your choice which method do you want to use.


Great, thanks
Draxxa Kireth
13 Nov 2017, 12:35am
maybe too obvious, but spent most of the time searching for the new plugin ...spent quite a while looking through GitHub ...but alas

I would indicate in the general info-pages that it's integrated in the newest version of EDMC, no need to search for the plugin



...in any case, well done!...wow!
Stiffhanger
14 Nov 2017, 2:26pm
Everything works well and makes this site the best. Thank you.
Jetkar
16 Nov 2017, 3:54pm
I notice that EDMC plug in will not update Mission / Combat logs will that come soon ?
Artie
16 Nov 2017, 4:34pm
JetkarI notice that EDMC plug in will not update Mission / Combat logs will that come soon ?

EDMC is updating mission and combat logs on jumps, dockings, etc. as expected. At least I didn't noticed any problems there. The Inara for EDMC plugin does contain the appropriate events too, in the latest plugin developer version.
Do you know any conditions when it doesn't work?

Last edit: 16 Nov 2017, 4:39pm
MrSheepSheep
16 Nov 2017, 5:11pm
I should rename it so it's easier to make the difference between the included Inara hook and the plugin.
Jetkar
16 Nov 2017, 5:39pm
Artie
JetkarI notice that EDMC plug in will not update Mission / Combat logs will that come soon ?


EDMC is updating mission and combat logs on jumps, dockings, etc. as expected. At least I didn't noticed any problems there. The Inara for EDMC plugin does contain the appropriate events too, in the latest plugin developer version.
Do you know any conditions when it doesn't work?


Its working however seem to be working after 2 jumps or station docks but will monitor

Post a reply

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