Examples

58 runnable programs from examples/, each shown here as it is in the repository. CI type-checks every one of them with npm run typecheck:examples, and the ones that need no token run against live ESI every night; a failure opens an issue. Every page says what the program needs and the command that runs it.

Client features

Example	What it shows	Needs
Cursor-based Pagination Example	ESI uses cursor-based pagination for newer routes like Freelance Jobs.	Token optional
Public versus authenticated, at the type level	esi.public is a PublicScopeTree: the operations that need no SSO scope.	No token needed
Rate Limiting & Pagination	Demonstrates rate-limiting awareness, pagination with large datasets, and error handling for non-existent resources.	No token needed
Retry, Timeout & Response Metadata	Demonstrates retry with exponential backoff, request timeouts, TimeoutError handling, and rich response metadata via withMetadata().	No token needed
Streaming Pagination	Demonstrates streaming through large paginated datasets page-by-page instead of loading everything into memory at once.	No token needed
Universe POST Helpers & Character Affiliation	Demonstrates the three safe read-only POST endpoints.	No token needed
Write Operations (Contacts, Fittings, Mail)	Demonstrates create → verify → cleanup for reversible write endpoints.	Needs an access token

Tokens and characters

Example	What it shows	Needs
Many characters, one runtime	Reads the wallet balance of every character an EsiTokenManager holds, through one shared runtime: one rate limiter, one error budget and one ETag cache for the whole application, and an immutable view per character.	Needs an access token
Token Manager	Demonstrates EsiTokenManager: the SSO login flow, persistent multi-character token storage, proactive refresh, a view for a character over the shared runtime (esi.as(tokens.identity(id))), and bulk refresh with a concurrency cap.	Needs an access token
Token Refresh	Demonstrates automatic token refresh using the onTokenRefresh callback.	Needs an access token

Public data

Example	What it shows	Needs
Alliance Information	Looks up an alliance, its member corporations, and icons.	No token needed
Character Lookup	Looks up a character's public info, portrait, and corporation.	No token needed
Corporation History and NPC Corporations	Follows a character's employment history, the alliance history and logo of their current corporation, then lists the NPC corporations and the loyalty store offers of one of them.	No token needed
Dogma & Item Types	Explores EVE's game mechanics data: item types, dogma attributes, and effects.	No token needed
Dogma Effects, Meta API & Sovereignty Systems	Demonstrates dogma effects lookup, the ESI OpenAPI spec endpoint, sovereignty system ownership, and war killmails.	No token needed
ESI Metadata	Reads ESI's own metadata: the API name, the compatibility dates it accepts, the latest changelog entries, and the health of each route.	No token needed
ESI.ts - Working Example: Complete Character Profile	This demonstrates how to use the ESI.ts library to gather comprehensive character information by combining multiple API calls efficiently.	Token optional
Faction Warfare Details	Demonstrates faction warfare leaderboards (overall, characters, corporations), faction wars, and per-character/corporation FW stats.	Token optional
Incursions & Faction Warfare	Shows active Sansha incursions and faction warfare statistics.	No token needed
Industry & Insurance	Fetches public industry data: facility locations, system cost indices, and insurance prices for ships.	No token needed
Market Prices	Fetches average market prices and price history for a specific item.	No token needed
Military Campaigns	Demonstrates the six military campaign endpoints.	Token optional
Paragon Hub SKINR Marketplace	Browses the Paragon Hub marketplace for SKINR ship customization designs.	Token optional
Public Contracts	Lists the public contracts in a region, then reads the items of the first item exchange and the bids on the first auction.	No token needed
Route Planner	Calculates the shortest route between two solar systems and looks up the name of each system along the way.	No token needed
Server Status	Quick check that the ESI API is reachable and the EVE server is online.	No token needed
SKINR Cosmetics	Looks up SKINR designs and a character's owned licenses and components.	Token optional
Sovereignty	Shows active sovereignty campaigns — contested structures, attack/defense scores, and event types.	No token needed
Universe Encyclopedia	Demonstrates the full breadth of public universe data endpoints.	No token needed
Universe Information	Fetches solar system, station, and constellation details.	No token needed
Wars	Fetches recent wars and shows details for the most recent one.	No token needed

Character and corporation data

Example	What it shows	Needs
Access Lists	Retrieves an access list (ACL) and displays its members grouped by entity type.	Needs an access token
Asset Inventory	Demonstrates character asset management: listing items, looking up locations and names in bulk via POST, and summarizing inventory.	Needs an access token
Calendar & Search	Demonstrates calendar event listing, event detail, event attendees, and character search.	Needs an access token
Character Details	Demonstrates character-specific endpoints: agents research, blueprints, roles, standings, titles, contact notifications, corporation history, jump fatigue, medals, and notifications.	Needs an access token
Contact Management	Demonstrates reading character contacts with standings and labels, and shows the available write operations (add, edit, delete contacts).	Needs an access token
Contracts Browser	Demonstrates browsing public region contracts (no auth) and fetching a character's personal contracts (auth required).	Needs an access token
Contracts, Contacts, Assets & Wallet	Demonstrates character contract bids/items, corporation contracts, alliance/corporation contacts, corporation assets, corporation wallets (journal + transactions), and public structure lookup.	Needs an access token
Corporation Details	Demonstrates all corporation-level endpoints: alliance history, icon, NPC corporations, and authenticated endpoints (blueprints, divisions, facilities, medals, members, roles, shareholders, standings, structures, etc).	Needs an access token
Corporation Projects	Demonstrates the Corporation Projects endpoints.	Needs an access token
Fittings & Clones	Demonstrates ship fitting management and clone state inspection.	Needs an access token
Fleet Operations	Demonstrates fleet management: checking a character's current fleet, fetching fleet details, listing members, and inspecting wing/squad structure.	Needs an access token
Freelance Jobs	Demonstrates the four Equinox freelance job endpoints.	Needs an access token
Industry Jobs & Mining	Demonstrates character industry jobs, mining ledger, corporation industry jobs, moon extraction timers, mining observers, and corporation killmails.	Needs an access token
Killmails	Demonstrates the two-step killmail lookup: first fetch recent killmail summaries for a character (auth required), then look up full details for each killmail using the public endpoint (no auth for the detail call).	Needs an access token
Location Tracker	Demonstrates real-time character location tracking: current system, online status, and current ship.	Needs an access token
Loyalty Points & Planetary Interaction	Demonstrates loyalty point balances, LP store offers, planetary colonies, colony layouts, customs offices, and PI schematics.	Needs an access token
Mail Inbox	Demonstrates character mail operations: reading inbox headers, viewing mail labels, listing mailing lists, and reading individual messages.	Needs an access token
Market Orders & Groups	Demonstrates character market orders, order history, corporation orders, market groups, and structure market orders.	Needs an access token
Mercenary Dens & Tactical Operations	Fetches mercenary dens across New Eden and their spawned tactical operations (MTOs), showing development and anarchy levels.	Needs an access token
Remaining Endpoint Coverage	Tests the 16 endpoints not covered by other examples.	Needs an access token
Skills Overview	Demonstrates character skill inspection including trained skills, skill queue, and neural remap attributes.	Needs an access token
Skyhooks & Sovereignty Hubs	Queries Upwell sovereignty structures — sovereignty hubs, orbital skyhooks with silo levels, and currently raidable skyhooks.	Needs an access token
Wallet Overview	Demonstrates character and corporation wallet operations including ISK balance, journal entries, and market transactions.	Needs an access token

Static Data Export (SDE)

Example	What it shows	Needs
Blueprint & Industry Data	Looks up a blueprint and displays its manufacturing requirements, resolving material type IDs to names via the SDE.	Needs local SDE data
SDE Basic Lookup	Demonstrates looking up static game data using the SDE module.	Needs local SDE data
SDE Market Group Tree	Walks the market group hierarchy recursively to display the full market category tree, optionally listing types in each leaf group.	Needs local SDE data
Ship Fitting with Dogma Attributes	Looks up a ship type and its dogma attributes to display fitting-relevant stats like powergrid, CPU, slot layout, and capacitor.	Needs local SDE data