---
title: "Get a Snapchat profile"
method: GET
path: "/v1/snapchat/profile"
tags: ["Snapchat"]
---

# Get a Snapchat profile

`GET /v1/snapchat/profile`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/snapchat/profile`
- Auth: API key in header `x-api-key`

Retrieve a public Snapchat profile, subscriber count, published stories, curated and Spotlight highlights, recent video metadata, Lenses and related profiles. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `handle` string, required

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_page' | 'public_comments', required
      - `complete` boolean, required
      - `warnings` string[], required
      - `order` 'source_order' | 'ranked'
    - `userProfile` object, required
    - `story` object, nullable, required
    - `storyMetadata` object, nullable, required
    - `curatedHighlights` object[], required
    - `spotlightHighlights` object[], required
    - `spotlightStoryMetadata` object[], required
    - `lenses` object[], required
    - `lensCursor` string, nullable, required
    - `curatedHighlightsCursor` string, nullable, required
    - `spotlightHighlightsCursor` string, nullable, required
    - `profile` object, required
      - `platform` 'snapchat', required
      - `handle` string, required
      - `displayName` string, nullable, required
      - `bio` string, nullable, required
      - `avatarUrl` string, nullable, required
      - `bannerUrl` string, nullable, required
      - `profileUrl` string, uri, required
      - `websiteUrl` string, nullable, required
      - `snapcodeUrl` string, nullable, required
      - `address` string, nullable, required
      - `category` string, nullable, required
      - `subcategory` string, nullable, required
      - `publisherType` string, nullable, required
      - `businessProfileId` string, nullable, required
      - `hasStory` boolean, nullable, required
      - `createdAt` string, nullable, required
      - `updatedAt` string, nullable, required
    - `metrics` object, required
      - `followers` integer, nullable, required
    - `spotlights` object[], required
      - `id` string, required
      - `url` string, uri, required
      - `caption` string, nullable, required
      - `generatedTitle` string, nullable, required
      - `generatedDescription` string, nullable, required
      - `keywords` string[], required
      - `hashtags` string[], required
      - `sound` object, nullable, required
        - `title` string, nullable, required
        - `creatorHandle` string, nullable, required
      - `thumbnailUrl` string, nullable, required
      - `videoUrl` string, nullable, required
      - `durationSeconds` number, nullable, required
      - `width` integer, nullable, required
      - `height` integer, nullable, required
      - `createdAt` string, nullable, required
      - `author` object, nullable, required
        - `handle` string, nullable, required
        - `displayName` string, nullable, required
        - `profileUrl` string, nullable, required
        - `avatarUrl` string, nullable, required
      - `metrics` object, required
        - `views` integer, nullable, required
        - `shares` integer, nullable, required
        - `comments` integer, nullable, required
        - `boosts` integer, nullable, required
        - `recommends` integer, nullable, required
    - `relatedAccounts` object[], required
      - `handle` string, nullable, required
      - `displayName` string, nullable, required
      - `profileUrl` string, nullable, required
      - `avatarUrl` string, nullable, required
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'restricted_page' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'response_too_large' | 'payload_too_complex' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)
