Skip to main content

Welcome to the MagicRail API Reference

Welcome to the MagicRail API reference guide. This document provides comprehensive details on the available endpoints, enabling developers to efficiently access and manage trip and location data.

MagicRail Trip API Overview​

Getting started with the MagicRail Trip API is straightforward. Follow these steps to authenticate, create, update, and retrieve trip data.

🔑 Authenticating with the MagicRail API​

Ensure you have valid credentials to authenticate requests. Authentication is required to secure communication with the API.

🛤️ Creating a New Trip​

Initiate a new trip session in the system. This will allow you to add location data associated with a unique trip identifier.

📍 Adding Location Data to Your Trip​

Once a trip is created, you can start adding geographical location data. This includes coordinates, timestamps, and any other relevant metadata. Repeat this process as needed to incorporate additional data throughout the duration of the trip.

🔍 Retrieving Trip and Location Data​

Access the stored trip and location data by querying the API with your trip identifier. This enables you to analyze trip metrics and patterns.

MagicRail Locations API Overview​

In addition to managing trip-based data, the MagicRail API also supports standalone location data. This allows you to store and retrieve geographical location data independently of any trips.

📍 Adding Standalone Location Data​

Log standalone location data including latitude, longitude, elevation, and time details. This is useful for tracking locations that are not part of a trip.

🔎 Retrieving Standalone Location Data​

Access the stored standalone location data using various search criteria such as time range, geographical bounding box, proximity, elevation range, metadata, and activity type.

MagicRail Helpers API Overview​

To improve location-related functionality, the MagicRail API provides helper endpoints, including city search suggestions to help users interact with location data more easily.

🔍 City Suggest Autocomplete API​

Utilize the City Suggest Autocomplete API to provide real-time city suggestions based on partial user input. This API dynamically suggests city names as the user types, ranking exact matches higher while supporting partial matches. This improves the user experience by offering relevant city suggestions, allowing users to quickly find and select the correct location.

Suggesting Product Enhancements​

We continuously strive to improve our products and services. If you have suggestions for product enhancements or new features, please don't hesitate to email us at [email protected]. Your feedback is invaluable to us and helps shape the future of MagicRail.

Getting Help​

If you encounter any issues or have questions, please refer to our support section or contact our development team directly at [email protected].