Quickstart - ScoutLayer Docs

Prerequisites

A ScoutLayer account — sign up free
An API key from Settings → API Keys

1. Get your API key

Open the dashboard and create a new API key. Copy it — you’ll need it in the next step.

Keep your API key secret. Never commit it to source control or expose it in client-side code.

2. Make your first request

Fetch the full detail of any Shopify app by its handle (the slug at the end of its App Store URL):

curl https://api.scoutlayer.io/v1/shopify/appstore/app/klaviyo \
  -H "X-API-Key: YOUR_API_KEY"

const res = await fetch(
  "https://api.scoutlayer.io/v1/shopify/appstore/app/klaviyo",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const app = await res.json();
console.log(app.name, app.rating, app.reviewCount);

import httpx

res = httpx.get(
    "https://api.scoutlayer.io/v1/shopify/appstore/app/klaviyo",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
app = res.json()
print(app["name"], app["rating"], app["reviewCount"])

3. Explore the response

A successful response looks like this:

{
  "name": "Klaviyo: Email Marketing & SMS",
  "handle": "klaviyo",
  "rating": "4.7",
  "reviewCount": 2891,
  "builtForShopify": "TRUE",
  "developer": {
    "name": "Klaviyo",
    "website": "https://www.klaviyo.com"
  },
  "pricings": [
    { "name": "Free", "price": "0", "period": "" },
    { "name": "Email", "price": "20", "period": "month" }
  ],
  "categories": [
    { "name": "Email marketing", "handle": "email-marketing" }
  ]
}

Next steps

App reviews

Pull paginated reviews sorted by relevance or date.

Keyword search

Search the App Store and get ranked results with sponsorship flags.

Category listings

Get all apps in a category with pagination.

Developer profiles

Look up a developer and all their published apps.

Introduction

Authentication

​Prerequisites

​1. Get your API key

​2. Make your first request

​3. Explore the response

​Next steps

App reviews

Keyword search

Category listings

Developer profiles

Prerequisites

1. Get your API key

2. Make your first request

3. Explore the response

Next steps