This API provides accurate **compass direction and bearing calculation** between two locations. It supports cities, addresses, ZIP codes, place names, and latitude/longitude coordinates, returning both the **bearing in degrees (0–360°)** and the **standard compass direction** (N, NE, E, SE, S, SW, W, NW).

Getting Started

To begin using this API, follow these steps and make your first API call: **Subscribe to a plan:** Visit our Pricing page and subscribe to one of the available plans. If you are just starting, you can subscribe to the free BASIC plan of the API (hard-limited and no credit card required). **Make your first API call:** Visit the RapidAPI Playground — the Compass Direction endpoint will be selected and displayed in the main panel. Enter the required parameters and click the blue **“Test Endpoint”** button. The JSON response will be displayed on the right panel. **Documentation and Resources:** Refer to the detailed endpoint descriptions, parameter explanations, and example responses provided in the Endpoints tab. Code snippets are available for popular programming languages and environments including JavaScript, Python, Java, Shell, and many others, allowing easy integration into your application or workflow. You should be good to go now!

Authentication

To authenticate with the API, send the **X-RapidAPI-Host** header along with the **X-RapidAPI-Key** header set to your RapidAPI App API Key (as shown in the endpoint Code Snippets).

Input Parameters

The following query parameters are supported by the API: **from** (required) Starting point coordinates or address for calculating the compass direction. Example: `New York, NY` **to** (required) Destination coordinates or address for calculating the compass direction. Example: `Los Angeles, CA`

Response Structure

Here’s an example of a successful response: ``` { "success": true, "from": { "location": "City of New York, New York, United States", "latitude": 40.7127281, "longitude": -74.0060152 }, "to": { "location": "Washington, District of Columbia, United States", "latitude": 38.8950368, "longitude": -77.0365427 }, "bearing_degrees": 214.87, "compass_direction": "SW" } ``` Please note that some errors might be returned by the RapidAPI gateway and may have a different structure. Refer to the Error Handling / Error Response Structure section for more details. In addition, the RapidAPI gateway adds several headers to each response. For more information, please refer to [https://docs.rapidapi.com/docs/response-headers](https://docs.rapidapi.com/docs/response-headers).

Endpoints

For detailed endpoint parameters, request examples, and response documentation, and to try the API, please refer to the **Endpoints** section of this API.

Rate Limiting

Each subscription plan defines the maximum number of requests permitted per month (quota), along with a rate limit expressed in RPS (Requests Per Second). Please note that all free plans (e.g., BASIC) are rate-limited to **1000 requests per hour**, which is a RapidAPI requirement for free-tier usage.

Rate Limits Headers

All API responses include rate limit information in the following headers: **x-ratelimit-requests-limit:** The total number of requests allowed under your current subscription plan. **x-ratelimit-requests-remaining:** The number of remaining requests before your quota is exhausted. This value resets daily or monthly depending on your plan configuration. You can view limits and usage in the RapidAPI Hub. **x-ratelimit-requests-reset:** The number of seconds remaining until the quota resets.

Handling Limits

When exceeding rate limits, the RapidAPI gateway will return a **429 Too Many Requests** error. When this occurs, wait until the quota resets or upgrade your subscription plan for higher limits. Custom quotas and rate limits are available upon request. Example response: ``` { "message": "Too many requests" } ```

Code Examples

Code examples are available for all popular programming languages and environments (JavaScript, Python, Java, Shell, etc.) in the **Endpoints** tab under **Code Snippets**.

Common HTTP Status Codes

**400 Bad Request:** Returned when the request is malformed or missing required parameters. The response may include a message explaining the error. **403 Forbidden:** Indicates that you are not subscribed to the API or the API key is invalid. If you believe this is an error, contact RapidAPI support. **404 Not Found:** Returned when an invalid endpoint is accessed. **429 Too Many Requests:** Indicates the rate limit has been exceeded. Wait for reset or upgrade your plan. **5XX Server Error (500, 502, 503):** Indicates a temporary server-side issue. If the problem persists, please contact support.

Support

If you experience issues or need clarification regarding errors or responses, please contact us with the error code, message, and request details. We will assist you promptly.

Contact Us

For custom plans, higher rate limits, enterprise usage, or custom API services, feel free to contact us. **Email:** [alreadycoded@gmail.com](mailto:alreadycoded@gmail.com) **Website:** [https://www.alreadycoded.com](https://www.alreadycoded.com)