Eggs API

📋 Table of Contents

• Overview

• Egg Management

• Egg Operations

• Egg Analytics

• Error Responses

Overview

The Eggs API provides egg collection and hatching functionality for the STAR ecosystem. It handles egg creation, collection, hatching, and rewards.

Egg Management

Get All Eggs

GET /api/eggs
Authorization: Bearer YOUR_TOKEN

Get Egg by ID

GET /api/eggs/{eggId}
Authorization: Bearer YOUR_TOKEN

Create Egg

POST /api/eggs
Authorization: Bearer YOUR_TOKEN

Update Egg

PUT /api/eggs/{eggId}
Authorization: Bearer YOUR_TOKEN

Delete Egg

DELETE /api/eggs/{eggId}
Authorization: Bearer YOUR_TOKEN

Egg Operations

Collect Egg

POST /api/eggs/{eggId}/collect
Authorization: Bearer YOUR_TOKEN

Hatch Egg

POST /api/eggs/{eggId}/hatch
Authorization: Bearer YOUR_TOKEN

Get User Eggs

GET /api/eggs/user/{userId}
Authorization: Bearer YOUR_TOKEN

Egg Analytics

Get Egg Stats

GET /api/eggs/stats
Authorization: Bearer YOUR_TOKEN

Get Egg Leaderboard

GET /api/eggs/leaderboard
Authorization: Bearer YOUR_TOKEN

Error Responses

Egg Not Found

{
  "result": null,
  "isError": true,
  "message": "Egg not found"
}

Already Collected

{
  "result": null,
  "isError": true,
  "message": "Egg already collected"
}

---

Navigation

← Previous: Messaging API | Next: CelestialBodies API →