API Access

The Map Your Store public API lets you access your store data and route optimization from your own tools and scripts. API access is available to Premium and Family plan subscribers.

For Developers

This section is intended for users with some technical background who want to integrate Map Your Store data into their own applications or workflows.

What the API Offers

The public API provides two main capabilities:

• Store data — Retrieve information about your stores, including layouts and aisle details.
• Route optimization — Get an optimized shopping route for a store given a list of items.

Creating an API Key

1. Sign in to Map Your Store.
2. Go to Settings > API Keys.
3. Select Create API Key.
4. Give your key a name (for example, "Home automation" or "Shopping script").
5. Copy the key immediately. The full key is only shown once. It is stored securely and cannot be retrieved later.

You can create multiple keys and delete any key you no longer need from the same settings page.

API Key Security

• Your API key is displayed in full only at the moment of creation. Copy it and store it somewhere safe.
• Map Your Store stores a hashed version of your key. If you lose it, you'll need to create a new one.
• Never share your API key publicly or include it in code that others can see.
• If you believe a key has been compromised, delete it immediately and create a replacement.

Available Endpoints

List Your Stores

GET /api/v1/stores

Returns a list of stores associated with your account, including store names, addresses, and layout information.

Get an Optimized Route

GET /api/v1/stores/:id/route

Returns an optimized shopping route for the specified store. Pass your shopping list items as query parameters to receive the best path through the aisles.

Replace :id with your store's unique identifier.

Authentication

Include your API key in the request header:

X-API-Key: your-api-key-here

All requests must include a valid API key. Requests without a key or with an invalid key will be rejected.

Rate Limits

API requests are rate-limited to ensure fair usage for all subscribers. If you exceed the limit, you'll receive an error response. Wait a moment and try again.

Getting Help

If you run into issues with the API or have questions about integration, reach out through the in-app support channel.