Munchix
shopping_bagLogin
API v2.0.0 — Production Ready

Munchix Developer Portal

REST API documentation for Karachi's hyperlocal home-chef marketplace. Authenticate once, discover dishes, place orders, and track deliveries.

OpenAPI v3 Spec (JSON)RFC 9727 API CatalogAgent Docs (llms-full.txt)

Base URL

getmunchix.com/api/v1

Auth

Bearer (Sanctum)

Format

JSON / problem+json

Rate Limit

60 req / minute

Authentication

Protected endpoints require a Sanctum Bearer token.

# 1. Get a token

POST /api/v1/auth/login

{ "email": "...", "password": "..." }

# 2. Include in all protected requests

Authorization: Bearer <token>

API Endpoints

All endpoints are prefixed with /api/v1. Full typed schemas are in the OpenAPI spec.

GET/api/v1/dishesBrowse home dishes with optional geofencing.
GET/api/v1/kitchens/nearbyList verified nearby home kitchens by area or coordinates.
GET/api/v1/social-feedLive social posts from Instagram & Facebook (cached 30 min).
POST/api/v1/auth/send-otpSend a 6-digit registration OTP to a given email address.
POST/api/v1/auth/registerComplete user registration (Customer, Chef, or Rider) after OTP.
POST/api/v1/ordersCreate a Cash on Delivery order from a verified kitchen.🔒 Auth Required

Error Responses (RFC 9457)

All errors return application/problem+json — never HTML. Agents can always parse and act on error responses.

{
  "type":     "https://getmunchix.com/docs/errors#validation-error",
  "title":    "Unprocessable Entity",
  "status":   422,
  "detail":   "One or more input fields failed validation.",
  "instance": "api/v1/auth/register",
  "hint":     "Fix the field errors listed in the errors object.",
  "errors": {
    "email": ["The email field is required."]
  }
}
HTTP 401unauthenticatedNo valid Bearer token. Authenticate via POST /api/v1/auth/login.
HTTP 403forbiddenAuthenticated but insufficient role permissions.
HTTP 404not-foundEndpoint or resource does not exist.
HTTP 404resource-not-foundA specific database record was not found by its ID.
HTTP 405method-not-allowedHTTP method is not allowed on this endpoint.
HTTP 422validation-errorOne or more input fields failed validation. Field errors are in the 'errors' object.
HTTP 429rate-limit-exceededRate limit hit. Check Retry-After header and wait before retrying.
HTTP 500internal-server-errorUnexpected server error. Munchix team is automatically notified.

Rate Limits

Rate-limit state is always visible in response headers — agents can self-throttle without guessing.

X-RateLimit-Limit

Max requests allowed per minute window.

X-RateLimit-Remaining

Remaining requests in current window.

X-RateLimit-Reset

Unix timestamp when the window resets.

Retry-After

Seconds to wait after a 429 Too Many Requests.

Versioning & Deprecation

Current stable version: v2.0.0. All responses include:

Link: <https://getmunchix.com/docs/api-versioning>; rel="deprecation-policy"

Link: <https://getmunchix.com/openapi.json>; rel="describedby"

Deprecation: false

Future deprecations are announced 90 days in advance via a Deprecation header (RFC 7231 date) and a Sunset header (removal timestamp).

More Resources

OpenAPI v3 Spec

Full typed schema for all endpoints.

API Catalog (RFC 9727)

Machine-readable service descriptor linkset.

Platform Docs (LLM)

Full agent & integration guide in markdown.

Pricing & Fees

Machine-readable fee structures and limits.

Contact Support

support@getmunchix.com or WhatsApp +92-322-0275616.

Terms of Service

API usage terms and acceptable use policy.