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.
Jetkar
25 Jan 2018, 8:02am
Will the Inara ap work Beta version of ED Beyond?
Artie
25 Jan 2018, 11:06am
There will be an improvements and new functionalities added into the Inara API during the beta (and maybe shortly after that, depends how the implementation will be going and how long the beta will be). API doesn't differ if the data are coming from the live game or beta, it depends on the apps using it. But generally, there is not recommended to send beta data to live accounts due the nature of beta, unless it is a some test version used on the test account for development/debug purposes.
Jetkar
25 Jan 2018, 2:23pm
ArtieThere will be an improvements and new functionalities added into the Inara API during the beta (and maybe shortly after that, depends how the implementation will be going and how long the beta will be). API doesn't differ if the data are coming from the live game or beta, it depends on the apps using it. But generally, there is not recommended to send beta data to live accounts due the nature of beta, unless it is a some test version used on the test account for development/debug purposes.


Thanks for the info Artie
James Hussar
30 Jan 2018, 6:42pm
@Artie, I'm seeing location and ship name syncing but not credits. Is there something I'm missing in how and when ED:MC syncs over?
Artie
30 Jan 2018, 8:29pm
Maybe. As far as I know, EDMC sends credits changes primarily when the difference is 5% or 10% since the last known state (I am not sure about the exact percentage now). Otis will know more.
James Hussar
30 Jan 2018, 9:34pm
Looks like my credit info hasn't been updated since Jan 12th. I've been playing a lot since then, and the API log shows plenty of activity - just not moving the credit needle at all. It's weird.
Artie
06 Feb 2018, 4:39pm
Guys, there is an update for the API related to 3.0, if it will be useful for you:
  • new: setCommanderReputationMajorFaction event for commander's reputation with Federation, Alliance, etc.
  • new: setCommanderStorageModules event for commander's stored modules
  • new: setCommanderShipLoadout event for the individual ship loadouts (please note that blueprints conversion for some modules (like those in utility slots) may not be performed at this moment, as I do not have all blueprints identifiers yet)
  • new: setCommanderGameStatistics event for the commander's in-game statistics
  • added: isHot and shipRebuyCost properties in setCommanderShip (there is currently a bug in the journals reporting the rebuy cost lower than it should be, but it will be fixed in 3.0 release)
  • added: completionBonus property in setCommunityGoal, also there is now possible to get tierMax from the journals in 3.0
  • worth to be mentioned: There are now hull and modules values for the ships in the journal (Loadout event), but keep in mind these values may not be in all Loadout events. There is possible to get overall/current assets value in the game statistics (Statistics event). Also the community goal journal events were enhanced for the goal IDs, so you can get them directly.
Blazer(JM)
07 Feb 2018, 5:17pm
Not sure if this is he right place, but I was wondering how to get the game statistics page to update? Everything in it is labeled unknown.
Artie
07 Feb 2018, 5:31pm
As mentioned in the updates thread, it is a feature for 3.0 so it can be ignored for now. But it will be live shortly, as there is expected that 3.0 will be released in a week.
Blazer(JM)
07 Feb 2018, 6:12pm
Ok. Sorry and thanks
Tenshi
13 Feb 2018, 7:28pm
I know this is going to sound paranoid but does anyone here use the E:D Market Connector app? I only ask because it asks for my Elite log in details and I don't like that idea.
Artie
13 Feb 2018, 7:54pm
EDMC is safe to use, although it requires the game credentials, it is used only to access an official companion API (as you can also take a look into its source code). Just from Inara API records, it is used by thousands of commanders here.
Phelbore
13 Feb 2018, 8:17pm
As long as your login details aren't the same as your bank or email, I wouldn't worry about it.  EDMC isn't a scam hunting for your login, however there have been times with other projects (browser extensions come to mind) where a developer was phished or hacked leading to compromised updates.  Again, this hasn't happened to EDMC as far as I know, but that's no excuse to avoid good security practices.

Edit: I use EDMC every time I play and don't worry about it.

Last edit: 13 Feb 2018, 8:23pm
Athanasius
14 Feb 2018, 5:36am
TenshiI know this is going to sound paranoid but does anyone here use the E:D Market Connector app? I only ask because it asks for my Elite log in details and I don't like that idea.

In addition to what others have said, you'll note that both the game and CAPI use, such as for EDMC, require entering the auth code you get in email. The one thing someone could do with use the username and password (assuming they're not shared with another account as Phelbore said) is login as you to your frontier account on the website/store. They could get your personal details from there, but otherwise the 'worst' they could do is buy you some stuff ?

Add your voice to the calls for Frontier to implement some Two Factor Authentication on the website/store (heck, the forums have the option for that account!), then the username and password alone wouldn't allow anyone to do anything.

In the case of at least EDMC, EDDI and ED Discovery they're well enough known, and the developers known to EDCD folk that they can be trusted. Not that this precludes one of them having poor security practices and their deployment mechanism getting compromised....

For complete disclosure I have also heard there's a bug/exploit/workaround for the emailed auth codes. I have a suspicion as to what it might be, but it would require something I don't have in order to test it (he says being cagey so as not to give others ideas).
Tenshi
14 Feb 2018, 8:53pm
Athanasius
TenshiI know this is going to sound paranoid but does anyone here use the E:D Market Connector app? I only ask because it asks for my Elite log in details and I don't like that idea.


In addition to what others have said, you'll note that both the game and CAPI use, such as for EDMC, require entering the auth code you get in email. The one thing someone could do with use the username and password (assuming they're not shared with another account as Phelbore said) is login as you to your frontier account on the website/store. They could get your personal details from there, but otherwise the 'worst' they could do is buy you some stuff ?

Add your voice to the calls for Frontier to implement some Two Factor Authentication on the website/store (heck, the forums have the option for that account!), then the username and password alone wouldn't allow anyone to do anything.

In the case of at least EDMC, EDDI and ED Discovery they're well enough known, and the developers known to EDCD folk that they can be trusted. Not that this precludes one of them having poor security practices and their deployment mechanism getting compromised....

For complete disclosure I have also heard there's a bug/exploit/workaround for the emailed auth codes. I have a suspicion as to what it might be, but it would require something I don't have in order to test it (he says being cagey so as not to give others ideas).


Thank you.
Always nice to get more information on things like this.

Post a reply

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