🐎 Horse API Index

Welcome! Below are the available endpoints, methods, and example requests.

🔑 Authentication

      POST /api/v1/auth/signup
      {
        "username": "<johndoe>",
        "email": "<johndoe@sample.com>",
        "password": "<yourpassword>"
      }

      POST /api/v1/auth/login
      {
        "loginKey": "<johndoe@sample.com>",
        "password": "<yourpassword>"
      }

      POST /api/v1/auth/forgot-password
      {
        "email": "<johndoe@sample.com>",
      }

      GET /api/v1/auth/userprofile
      Authorization: Bearer <token>
    

👥 Members

      GET /api/v1/members
      Authorization: Bearer <token>
    

🐴 Horses

      GET /api/v1/horses?page=1&limit=50
      Authorization: Bearer <token>

      GET /api/v1/horses/real?horseid=<horseid>&gen=<generation>
      GET /api/v1/horses/hypo?sireid=<sireid>&damid=<damid>&gen=<generation>

      GET /api/v1/horses/4/pedigree
    

📊 Plans

      GET /api/v1/plans
    

ℹ️ Notes

• All protected routes require Authorization: Bearer <token>.
• Use Content-Type: application/json for POST requests.
• Pagination supported via ?page=<pagenumber>&limit=<limit> query params.