Overview

This is the official document for Eagle API. By releasing Eagle's API, we hope that every user could make the most of these functions and develop more personalized plugins or add-ons to address various needs. In this document, along with the exhaustive introduction to the Eagle API, we also provided some examples for reference to inspire users to make creative plugins on basis of these scripts.

Remark: By using Eagle API and its derivatives, you represent and warrant that you have read and agree to our User Agreement and Privacy Policy.

Server

Eagle is a local based application, the Eagle API server will start up when Eagle App is opened, hence you'd have to open Eagle App first to gain access to all function of Eagle API.

Format

All API server will start-up upon opening Eagle App, the default listening port is 41595, i.e. http://localhost:41595/ . Results returned will be in JSON format.

CORS

If you want to use Eagle API in webpages via script extensions like 'Tampermonkey', please call through GM_xmlhttprequest to circumvent security policies related to Cross-Origin Resource Sharing.

GM_xmlhttpRequest({
    url: EAGLE_IMPORT_API_URL,
    method: "POST",
    data: JSON.stringify({ items: images, folderId: pageInfo.folderId }),
    onload: function(response) {}
});

Limitation

Eagle 1.11 Build21 (Released on 2020/06/17) or the latter version is required to gain access to Eagle API.

The performance of the API server is dependant on the device you are currently running Eagle. There is no limit on the number of calls since all connections were done locally. Almost every add-item API function have a respective version for adding multiple items, we suggest you use the multiple ones if you intend to add lots of files.

Submit Feature Requests

The Eagle API has provided most of the functions you would need to create/add items, if you find API insufficient or incapable under some circumstances, feel free to submit your feature request!

Mail to: [e-mail] Title: Feature Request for Eagle API: A brief description of the requested feature. Content: Please describe the script or extension you are developing, and advise more detail about why the proposed feature is necessary.