ei_worker makes it easy to interact with the Egg, Inc. API using HTTP requests and JSON.
https://ei_worker.tylertms.workers.dev
| Endpoint | Parameters | Response |
|---|---|---|
/active_artifacts |
eid, optional contract |
Equipped artifacts |
/active_missions |
eid, optional reset_index |
Active artifact missions |
/afx_config |
eid |
Artifact configuration |
/archive |
eid |
Contract archive |
/artifact_inventory |
eid |
Artifact inventory, sets, and crafting status |
/backup |
eid |
Player backup |
/colleggtibles |
eid |
Colleggtible progress, tiers, and buffs |
/completed_mission |
eid, mission_id |
Completed artifact mission result |
/contract |
eid, contract, coop |
Coop status |
/contract_evaluations |
eid |
Contract evaluation history and XP summary |
/contracts |
eid |
Active, available, and completed contract summaries |
/coop_buffs |
eid, contract, coop |
Deflector and SIAB totals as CSV |
/coop_summary |
eid, contract, coop |
Ranked coop members, production, activity, and buffs |
/events |
eid |
Current events and boost multipliers |
/farms |
eid |
Structured home and contract farm details |
/leaderboard |
eid, scope, grade |
Leaderboard data |
/leaderboard_info |
None | Leaderboard metadata |
/missions |
eid |
Fueling, active, returned, and archived artifact missions |
/periodicals |
eid |
Current contracts and events |
/player_summary |
eid |
Compact player, farm, contract, artifact, and subscription data |
/season_info |
None | Contract season metadata |
/sub_status |
eid |
Subscription status |
/yon_farm_info |
eid |
Farm, research, artifact, event, and colleggtible report as CSV |
Examples:
/backup?eid=EI1234567890123456
/active_artifacts?eid=EI1234567890123456&contract=contract_id
/contract?eid=EI1234567890123456&contract=contract_id&coop=coop_name
/completed_mission?eid=EI1234567890123456&mission_id=mission_identifier
/leaderboard?eid=EI1234567890123456&scope=ALL_TIME&grade=5
/active_missions?eid=EI1234567890123456&reset_index=12
Errors use this JSON shape:
{
"error": {
"code": "missing_parameter",
"message": "Missing required parameter: eid"
}
}Requires Node.js 22 or newer.
git clone https://github.com/tylertms/ei_worker.git
cd ei_worker
npm ci
npm run dev
Local development and integration tests read configuration from an ignored .env file:
EI_TEST_EID=EI1234567890123456
MAGIC=your_magic_value
INDEX=your_index
MARKER=your_markerAll four values are required by the live test suite. Configure matching Worker secrets in Cloudflare for production.
Validation commands:
npm audit
npm run check
npm test
npm run build
Live API tests are opt-in and read the private test account identifier from .env:
npm run test_integration
The live suite exercises every endpoint against Egg, Inc. Contract and coop identifiers are taken from the test account when available, with guaranteed nonexistent identifiers used otherwise. The suite does not include the EID or returned account data in test output or tracked files.
Deploy with:
npm run deploy