Skip to main content

Lumar GraphQL API

Programmatic access to Lumar's website intelligence platform. Build integrations, automate crawls, and extract insights using a single GraphQL endpoint.

Get StartedOpen Explorer
GraphQL
query GetHealthScores {
  me {
    projects(first: 3) {
      nodes {
        name
        primaryDomain
        lastFinishedCrawl {
          createdAt
          crawlStatus
          healthScores {
            healthScore
            category
            changeFromPrevious
          }
        }
      }
    }
  }
}

Documentation

Guides on authentication, queries, mutations, and integrating with the Lumar platform.

API Explorer

Interactive GraphQL playground — write queries, explore the schema, and test against live data.

Schema Reference

Auto-generated reference for every type, query, mutation, and enum in the GraphQL schema.

Quick Start

The Lumar API uses GraphQL — a query language that lets you request exactly the data you need. All requests go to a single endpoint.

  1. Create a service account — generate a service account and key from your Lumar account settings.
  2. Send a query — POST your GraphQL query to the API endpoint with your service account key in the x-api-key header.
  3. Get results — receive JSON responses with exactly the fields you requested.
Read the full guide
cURL
curl -X POST https://api.lumar.io/graphql \
  -H "Content-Type: application/json" \
  -H "x-api-key: lmr_sa_123_your-secret-key" \
  -d '{"query": "{ version }"}'