Get a Snapchat Lens

Try in Playground

Retrieve a public Lens with its creator, tags, preview image and video, Snapcode, related Lenses and Spotlight videos using the effect.

GET/v1/snapchat/lensx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Required HTTPS Snapchat Lens URL with a 32-character hexadecimal or hyphenated UUID identifier.

max 4096 chars

Examplehttps://www.snapchat.com/lens/00000000000040008000000000000001

Response fields

requestIdstring

Request correlation UUID.

Upstream request count, decoded response bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Upstream HTTP attempts used by this request.

≥ 0

accounting.responseBytesinteger

Decoded source response bytes.

≥ 0

accounting.durationMsnumber

Elapsed retrieval milliseconds.

≥ 0

successboolean

True when usable Snapchat data is returned.

statusenum

success or partial for usable data. Failure responses use failed or challenged.

one of: success, partial

sourceUrlstring

Canonical Snapchat page or Spotlight URL.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Source, completeness and warnings for the returned public records.

coverage.sourceenum

public_page or public_comments.

one of: public_page, public_comments

coverage.completeboolean

Whether the selected source response was returned without a reported omission.

coverage.warningsstring[]

Warning codes describing omitted or additional records.

coverage.orderenumoptional

Returned record order, such as ranked or source_order.

one of: source_order, ranked

lensDisplayInfoobject

Original public Lens record: scannableUuid, lensName, lensCreatorDisplayName, lensCreatorUsername, userProfileUrl, lensPreviewImageUrl, lensPreviewVideoUrl, iconUrl, unlockUrl, lensResource, lensId, lensCreatorSearchTags, isOfficialSnapLens, lastUpdatedEpoch and scannableImageUrl. Source extensions are preserved.

lensMetadataobjectnullable

Additional source Lens metadata, or null.

moreLensesobject[]

Related public Lens records with their original source fields.

up to 100 items

spotlightsUsingThisLensobject[]

Published Spotlight story records using the Lens, with source snap IDs, types, URLs, thumbnails and timestamps.

up to 100 items

spotlightsUsingThisLensMetadataobject[]

Metadata aligned to the related Spotlight stories, including video, creator, caption and engagement.

up to 100 items

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, unknown or malformed parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The requested page reports restricted access.
404	`not_found`	The requested public record was not found.
429	`upstream_rate_limited`	Snapchat temporarily rate limited retrieval.
502	`upstream_challenged`	Snapchat challenged the request.
502	`unsupported_page`	The public source does not validate against the supported structure.
502	`response_too_large` `payload_too_complex`	The source exceeded byte or structural bounds.
502	`unsafe_redirect` `request_limit` `upstream_error`	Retrieval could not complete within its source and request bounds.
503	`busy`	The worker admission queue is full or its wait deadline was exceeded.
504	`timeout`	The request exceeded its deadline.

Code example

curl "https://api.scrapeatlas.com/v1/snapchat/lens?url=https%3A%2F%2Fwww.snapchat.com%2Flens%2F00000000000040008000000000000001" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/snapchat/lens?url=https%3A%2F%2Fwww.snapchat.com%2Flens%2F00000000000040008000000000000001",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/snapchat/lens?url=https%3A%2F%2Fwww.snapchat.com%2Flens%2F00000000000040008000000000000001",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Snapchat request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/snapchat/lens",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://www.snapchat.com/lens/00000000000040008000000000000001"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/snapchat/lens?url=https%3A%2F%2Fwww.snapchat.com%2Flens%2F00000000000040008000000000000001", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/snapchat/lens?url=https%3A%2F%2Fwww.snapchat.com%2Flens%2F00000000000040008000000000000001"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000099",
  "sourceUrl": "https://www.snapchat.com/lens/00000000000040008000000000000001",
  "fetchedAt": "2026-10-06T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": [],
    "order": "source_order"
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 9000,
    "durationMs": 450
  },
  "lensDisplayInfo": {
    "scannableUuid": "00000000000040008000000000000001",
    "lensName": "Synthetic Lens",
    "lensCreatorDisplayName": "Example Creator",
    "lensPreviewImageUrl": "https://cf-st.sc-cdn.net/synthetic-lens.jpg",
    "lensPreviewVideoUrl": "https://cf-st.sc-cdn.net/synthetic-lens.mp4",
    "iconUrl": "https://cf-st.sc-cdn.net/synthetic-lens-icon.png",
    "unlockUrl": "https://www.snapchat.com/lens/00000000000040008000000000000001",
    "lensResource": {
      "lensId": "100001"
    },
    "userProfileUrl": "https://www.snapchat.com/@example.creator",
    "lensCreatorUsername": "example.creator",
    "lensId": "100001",
    "lensCreatorSearchTags": [
      "synthetic"
    ],
    "isOfficialSnapLens": false,
    "lastUpdatedEpoch": "1700000000",
    "scannableImageUrl": "https://cf-st.sc-cdn.net/synthetic-lens-snapcode.png"
  },
  "lensMetadata": null,
  "moreLenses": [],
  "spotlightsUsingThisLens": [
    {
      "storyType": 1,
      "snapList": [
        {
          "snapIndex": 0,
          "snapId": {
            "value": "Synthetic_Spotlight_Identifier_001"
          },
          "snapMediaType": 1,
          "snapUrls": {
            "mediaUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
            "mediaPreviewUrl": {
              "value": "https://cf-st.sc-cdn.net/synthetic.jpg"
            },
            "overlayUrl": null,
            "attachmentUrl": null
          },
          "timestampInSec": {
            "value": "1700000000"
          },
          "snapTitle": null
        }
      ],
      "storyId": {
        "value": "Synthetic_Spotlight_Identifier_001"
      },
      "storyTitle": null,
      "thumbnailUrl": {
        "value": "https://cf-st.sc-cdn.net/synthetic.jpg"
      },
      "storyTapId": "",
      "thumbnailTiles": []
    }
  ],
  "spotlightsUsingThisLensMetadata": [
    {
      "videoMetadata": {
        "name": "Synthetic generated title",
        "description": "Synthetic caption",
        "thumbnailUrl": "https://cf-st.sc-cdn.net/synthetic.jpg",
        "uploadDateMs": "1700000000000",
        "viewCount": "500",
        "contentUrl": "https://cf-st.sc-cdn.net/synthetic.mp4",
        "creator": {
          "$case": "personCreator",
          "personCreator": {
            "username": "example.creator",
            "url": "https://www.snapchat.com/@example.creator",
            "name": "Example Creator",
            "followerCount": "1200",
            "websiteUrl": "https://example.test"
          }
        },
        "durationMs": "12500",
        "width": 540,
        "height": 960,
        "keywords": [
          "synthetic"
        ],
        "shareCount": "10",
        "embeddedTextCaption": "Synthetic on-screen text"
      },
      "userMetadata": null,
      "lensMetadata": null,
      "hashtags": [
        "example"
      ],
      "contextCards": [
        {
          "contextType": 2,
          "title": "Original Sound",
          "subtitle": "example.creator",
          "id": "sound-001"
        }
      ],
      "engagementStats": {
        "viewCount": "500",
        "shareCount": "10",
        "commentCount": "2",
        "boostCount": "7",
        "recommendCount": "3"
      },
      "description": "Synthetic caption",
      "llmTitle": "Synthetic generated title",
      "llmDescription": "Synthetic generated description",
      "llmKeywords": [
        "synthetic generated keyword"
      ]
    }
  ]
}

Missing, duplicate, unknown or malformed parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}