Skip to content
scrapeatlas.Dashboard

Get a Snapchat profile

Try in Playground

Retrieve a public Snapchat profile, subscriber count, published stories, curated and Spotlight highlights, recent video metadata, Lenses and related profiles.

GET/v1/snapchat/profilex-api-key
x-api-keystringrequiredheader

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

Query parameters
1
handlestringrequiredquery

Required Snapchat handle; an initial @ is accepted.

Exampleexample.creator
Response fields
77
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

userProfileobject

Public source profile record with original field names, wrappers, IDs and extensions: username, title, badge, categoryStringId, subcategoryStringId, subscriberCount, bio, websiteUrl, profilePictureUrl, address, bitmoji3d, snapcodeImageUrl, squareHeroImageUrl, mutableName, publisherType, primaryColor, story/highlight flags, relatedAccountsInfo, creationTimestampMs, lastUpdateTimestampMs, businessProfileId, sameAsLinks, audienceGateSettings and hostUserId.

storyobjectnullable

Public story with source story ID, title, thumbnail and ordered snapList; null when absent. Snaps preserve IDs, media types, media/preview/overlay/attachment URLs and timestamps.

storyMetadataobjectnullable

Public story metadata with original source fields; null when absent.

curatedHighlightsobject[]

Published curated highlights, preserving story and snap fields.

up to 100 items

spotlightHighlightsobject[]

Published Spotlight stories, preserving original source records.

up to 100 items

spotlightStoryMetadataobject[]

Metadata corresponding to Spotlight highlights: video, creator, descriptions, hashtags, context cards, engagement and generated text.

up to 100 items

lensesobject[]

Published Lens records with original source fields.

up to 100 items

lensCursorstringnullable

Source continuation value for the profile Lens collection, or null.

curatedHighlightsCursorstringnullable

Source continuation value for curated highlights, or null.

spotlightHighlightsCursorstringnullable

Source continuation value for Spotlight highlights, or null.

Normalized public profile fields alongside the preserved source record.

profile.platformstring

snapchat.

profile.handlestring

Public username.

profile.displayNamestringnullable

Public display name.

profile.biostringnullable

Published biography, or null.

profile.avatarUrlstringnullable

Profile picture URL, or null.

profile.bannerUrlstringnullable

Published hero image URL, or null.

profile.profileUrlstring

Public profile URL.

absolute HTTPS URL

profile.websiteUrlstringnullable

Published website URL, or null.

profile.snapcodeUrlstringnullable

Public Snapcode image URL, or null.

profile.addressstringnullable

Published address, or null.

profile.categorystringnullable

Source category identifier, or null.

profile.subcategorystringnullable

Source subcategory identifier, or null.

profile.publisherTypestringnullable

Source publisher type, or null.

profile.businessProfileIdstringnullable

Public business profile ID, or null.

profile.hasStorybooleannullable

Public story flag, or null.

profile.createdAtstringnullable

Profile creation time in UTC, or null.

profile.updatedAtstringnullable

Profile update time in UTC, or null.

Normalized public audience counts.

metrics.followersintegernullable

Public subscriber count as a number, or null.

Normalized video metadata aligned to the profile Spotlight stories.

up to 100 items

spotlights.idstring

Snapchat Spotlight story identifier, preserved as a string.

spotlights.urlstring

Canonical public Spotlight URL.

absolute HTTPS URL

spotlights.captionstringnullable

Published description or caption, or null.

spotlights.generatedTitlestringnullable

Source generated title, or null.

spotlights.generatedDescriptionstringnullable

Source generated description, or null.

spotlights.keywordsstring[]

Published generated or video keywords.

up to 100 items

spotlights.hashtagsstring[]

Published hashtags.

up to 100 items

Published sound title and creator handle, or null.

spotlights.sound.titlestringnullable

Sound title.

spotlights.sound.creatorHandlestringnullable

Sound creator handle.

spotlights.thumbnailUrlstringnullable

Published thumbnail URL.

spotlights.videoUrlstringnullable

Published video media URL.

spotlights.durationSecondsnumbernullable

Video duration in seconds, or null.

spotlights.widthintegernullable

Video width in pixels, or null.

spotlights.heightintegernullable

Video height in pixels, or null.

spotlights.createdAtstringnullable

UTC upload time, or null.

Creator handle, display name, profile URL and avatar URL.

spotlights.author.handlestringnullable

Creator handle.

spotlights.author.displayNamestringnullable

Creator display name.

spotlights.author.profileUrlstringnullable

Public creator profile URL.

spotlights.author.avatarUrlstringnullable

Creator avatar URL, or null.

Public views, shares, comments, boosts and recommends. An unreported counter is null.

spotlights.metrics.viewsintegernullable

Published view count.

spotlights.metrics.sharesintegernullable

Published share count.

spotlights.metrics.commentsintegernullable

Published comment count.

spotlights.metrics.boostsintegernullable

Published boost count.

spotlights.metrics.recommendsintegernullable

Published recommend count.

Related public profiles with handles, display names, profile URLs and avatars.

up to 100 items

relatedAccounts.handlestringnullable

Related profile handle.

relatedAccounts.displayNamestringnullable

Related profile display name.

relatedAccounts.profileUrlstringnullable

Related public profile URL.

relatedAccounts.avatarUrlstringnullable

Related profile avatar URL.

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
11
HTTPfailure.codeMeaning
400invalid_requestMissing, duplicate, unknown or malformed parameters.
401unauthorizedMissing or invalid service API key.
403restricted_pageThe requested page reports restricted access.
404not_foundThe requested public record was not found.
429upstream_rate_limitedSnapchat temporarily rate limited retrieval.
502upstream_challengedSnapchat challenged the request.
502unsupported_pageThe public source does not validate against the supported structure.
502response_too_large payload_too_complexThe source exceeded byte or structural bounds.
502unsafe_redirect request_limit upstream_errorRetrieval could not complete within its source and request bounds.
503busyThe worker admission queue is full or its wait deadline was exceeded.
504timeoutThe request exceeded its deadline.