Getting Started
Welcome to the One Request API, connecting the realms of Middle-earth through a single unified interface. Our API provides programmatic access to locations, activities, groups, and more, allowing developers to create custom journey planning applications.
Base URL
All API requests should be directed to:
Request Format
The API accepts JSON for request bodies and returns JSON responses. All requests must include the appropriate Content-Type
header:
Authentication
One Request requires authentication for all API endpoints. We use JWT (JSON Web Tokens) for secure authentication.
Obtaining Tokens
To obtain an access token, make a POST request to the authentication endpoint:
Authenticates a user and returns access and refresh tokens.
Request Body:
- email - User's registered email
- password - User's password
Response:
Using Authentication
Include the access token in the Authorization header for all authenticated requests:
Token Refresh
When an access token expires, use the refresh token to obtain a new one:
Request Body:
- refresh_token - Valid refresh token
Locations
The Locations API provides access to our extensive catalog of vetted destinations across Middle-earth.
Returns a paginated list of all available locations.
Query Parameters:
- page - Page number (default: 1)
- size - Results per page (default: 20)
- sort - Sort field (name, id)
- order - Sort order (asc, desc)
Response:
Returns detailed information about a specific location.
Path Parameters:
- id - Location unique identifier
Activities
The Activities API allows discovery and booking of experiences across Middle-earth.
Returns a paginated list of available activities.
Query Parameters:
- location_id - Filter by location
- day - Filter by date (YYYY-MM-DD)
- price_min - Minimum price
- price_max - Maximum price
- currency - Currency (GOLD, SILV, MITH)
Creates a new activity.
Request Body:
- name - Activity name
- description - Detailed description
- price - Activity cost
- currency - Currency code (GOLD, SILV, MITH)
- day - Date of activity (YYYY-MM-DD)
- invite_code - Private activity access code
- group_id - Associated group ID
Groups
The Groups API enables fellowship management, allowing coordination between travelers.
Returns groups the authenticated user belongs to.
Creates a new group with the authenticated user as owner.
Request Body:
- name - Group name
- description - Group description
Returns chat messages for a specific group.
Path Parameters:
- id - Group unique identifier
Postman Collection
To simplify your development process, we provide a complete Postman collection containing all endpoints, example requests, and authentication workflows.
Using the Collection
- Download the collection JSON file
- Import into Postman using File → Import
- Set up an environment with your API credentials
- Run the authentication request to populate your tokens
OpenAPI Specification
One Request follows OpenAPI 3.0 specifications. The complete schema is available for download and can be used with tools like Swagger UI, ReDoc, or any OpenAPI-compatible code generator.
Our interactive documentation provides a convenient way to explore the API without leaving your browser. For the most comprehensive view, we recommend using the interactive docs.