# Snapchat API
> 5 endpoints for live Snapchat data — user search, detail, related, spotlights.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/snapchat-api/..."
```

## Pricing
- **Free** (Free) — 500 calls/Mo, 1 req/s
- **Basic** ($15/Mo) — 15,000 calls/Mo, 5 req/s
- **Pro** ($39/Mo) — 80,000 calls/Mo, 12 req/s
- **Mega** ($99/Mo) — 350,000 calls/Mo, 25 req/s

## Endpoints

### Users

#### `GET /v1/users/highlights` — A creator's saved highlight stories (curated + spotlight)

**Parameters:**
- `username` (query, required, string) — Snapchat username Example: `nba`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/snapchat-api/v1/users/highlights?username=nba"
```

**Response:**
```json
{
    "data": {
        "count": 32,
        "username": "nba",
        "highlights": [
            {
                "id": "029f2cc3-c0df-46c2-b610-485c137f9a0a",
                "type": "curated",
                "emoji": null,
                "title": "2025-26 NBA Finals 🏆",
                "subtitle": null,
                "share_url": null,
                "snap_count": 4,
                "thumbnail_url": "https://cf-st.sc-cdn.net/d/ZXSSacNIpSYqxAm21SSGc.410?mo=GjcaFjIBBDoBfUIGCMqG99AGSAJQXmABcAFQxQFaEERmTGFyZ2VUaHVtYm5haWyiAQcImgMiAhIA&uc=94"
            },
            {
                "id": "2941c1a3-96ba-45aa-bdf4-30b344e63e42",
                "type": "curated",
                "emoji": null,
                "title": "Your 2025-26 Kia NBA MVP 🏆",
                "subtitle": null,
                "share_url": null,
                "snap_count": 19,
                "thumbnail_url": "https://cf-st.sc-cdn.net/d/iqFfVpTceYNBTtMJvlQns.410.IRZXSOY?mo=GkAaFjIBBDoBfUIGCPa5qdAGSAJQXmABcAFQxQFaEERmTGFyZ2VUaHVtYm5haWyiARAImgMiCxIAKgdJUlpYU09Z&uc=94"
            },
            {
                "id": "918b1b3e-d60a-43e9-b5cd-651335d4687e",
                "type": "curated",
                "emoji": null,
                "title": "2026 All-Star Rosters ⭐️",
                "subtitle": null,
                "share_url": null,
                "snap_count": 5,
                "thumbnail_url": "https://cf-st.sc-cdn.net/d/OVtsXn5gkLRCgYX1bsKWn.410?mo=GjcaFjIBBDoBfUIGCNXEiswG
…(truncated, see openapi.json for full schema)
```

#### `GET /v1/users/lenses` — A creator's AR lenses

**Parameters:**
- `username` (query, required, string) — Snapchat username Example: `nba`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/snapchat-api/v1/users/lenses?username=nba"
```

**Response:**
```json
{
    "data": {
        "count": 16,
        "lenses": [
            {
                "id": null,
                "name": "NBA Draft 2024",
                "uuid": null,
                "creator": "NBA",
                "icon_url": "https://bolt-gcdn.sc-cdn.net/3/LlDGAagxVwN5d5Wn2vYgq?bo=EhgaABoAMgF9OgEEQgYIyvHnswZIAlASYAE%3D&uc=18",
                "unlock_url": "https://www.snapchat.com/unlock/?type=SNAPCODE&uuid=ace0170b8d524ecf8f07c4556b45089f&metadata=01",
                "creator_username": null,
                "preview_image_url": "https://lens-preview-storage.storage.googleapis.com/previewmedia/preview_thumbnail/4fd643ec-7e7d-4dcf-a05c-4e92c1676f61_360_640.webp",
                "preview_video_url": "https://lens-storage.storage.googleapis.com/previewvideo/1438e5a0-a230-4eb8-b940-c22cf8ae419c"
            },
            {
                "id": null,
                "name": "NBA All-Star 2024",
                "uuid": null,
                "creator": "NBA",
                "icon_url": "https://bolt-gcdn.sc-cdn.net/3/nOKEvpysPBn4ko5aWc2Ff?bo=EhgaABoAMgF9OgEEQgYIw56UrgZIAlASYAE%3D&uc=18",
                "unlock_url": "https://www.snapchat.com/unlock/?type=SNAPCODE&uuid=7784b5e49b474bed8be303d47f4dd9dd&metadata=01",
                "creator_username": null,
                "preview_image_url": null,
                "preview_video_url": "https://lens-storage.storage.googleapis.com/previewvideo/2513eae5-f65a-48c6-beed-a0a0293c1475"
            },
            {
          
…(truncated, see openapi.json for full schema)
```

#### `GET /v1/users/search` — Search users

**Parameters:**
- `query` (query, required, string) — Search query Example: `jlo`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/snapchat-api/v1/users/search?query=jlo"
```

**Response:**
```json
{
    "data": {
        "count": 1,
        "users": [
            {
                "id": "d278c2a0-5c8e-447b-8711-cfca0c15ca07",
                "link": "https://www.snapchat.com/add/jlo",
                "username": "jlo",
                "is_popular": false,
                "is_official": false,
                "snap_pro_id": "a2d94d79-6df1-46de-a0a8-75b63b26bcbd",
                "display_name": "Jonathan",
                "profile_logo_url": "https://cf-st.sc-cdn.net/aps/bolt/aHR0cHM6Ly9jZi1zdC5zYy1jZG4ubmV0L2QvRWFaNEpvN3hBajNUYVVtbElPUVM3P2JvPUVnMGFBQm9BTWdFRVNBSlFHV0FCJnVjPTI1._RS0,640_FMjpeg"
            }
        ]
    },
    "meta": {
        "timestamp": "2026-05-04T13:59:42.455Z",
        "request_id": "cbd35eff-fa90-4866-a7e6-9d9cb3c0db48"
    },
    "status": "ok",
    "message": "Users retrieved successfully",
    "success": true
}
```

#### `GET /v1/users/detail` — User detail

**Parameters:**
- `username` (query, required, string) — Snapchat username Example: `jlo`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/snapchat-api/v1/users/detail?username=jlo"
```

**Response:**
```json
{
    "data": {
        "id": "d278c2a0-5c8e-447b-8711-cfca0c15ca07",
        "bio": "🤝",
        "link": "https://www.snapchat.com/add/jlo",
        "badge": 0,
        "title": "Jonathan",
        "address": null,
        "category": "public-profile-category-v3-people",
        "username": "jlo",
        "has_story": false,
        "subcategory": "public-profile-subcategory-v3-entrepreneur",
        "website_url": null,
        "display_name": "Jonathan",
        "subscriber_count": 57200,
        "snapcode_image_url": "https://app.snapchat.com/web/deeplink/snapcode?username=jlo&type=SVG&bitmoji=enable",
        "business_profile_id": "a2d94d79-6df1-46de-a0a8-75b63b26bcbd",
        "profile_picture_url": "https://cf-st.sc-cdn.net/aps/bolt/aHR0cHM6Ly9jZi1zdC5zYy1jZG4ubmV0L2QvRWFaNEpvN3hBajNUYVVtbElPUVM3P2JvPUVnMGFBQm9BTWdFRVNBSlFHV0FCJnVjPTI1._RS0,90_FMjpeg",
        "creation_timestamp_ms": 1602696719006,
        "has_curated_highlights": false,
        "has_spotlight_highlights": false,
        "last_update_timestamp_ms": 1776456953897
    },
    "meta": {
        "timestamp": "2026-05-04T13:59:42.906Z",
        "request_id": "060525e6-f31e-4951-835f-761576750787"
    },
    "status": "ok",
    "message": "User detail retrieved successfully",
    "success": true
}
```

#### `GET /v1/users/id` — User ID

**Parameters:**
- `username` (query, required, string) — Snapchat username Example: `jlo`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/snapchat-api/v1/users/id?username=jlo"
```

**Response:**
```json
{
    "data": {
        "id": "d278c2a0-5c8e-447b-8711-cfca0c15ca07",
        "username": "jlo",
        "business_profile_id": "a2d94d79-6df1-46de-a0a8-75b63b26bcbd"
    },
    "meta": {
        "timestamp": "2026-05-04T13:59:43.300Z",
        "request_id": "05df243f-1e28-4181-92a0-5a75dc08f536"
    },
    "status": "ok",
    "message": "User ID retrieved successfully",
    "success": true
}
```

#### `GET /v1/users/related` — Related users

**Parameters:**
- `username` (query, required, string) — Snapchat username Example: `jlo`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/snapchat-api/v1/users/related?username=jlo"
```

**Response:**
```json
{
    "data": {
        "count": 3,
        "users": [
            {
                "id": null,
                "bio": null,
                "link": "https://www.snapchat.com/add/jbalvin",
                "badge": 0,
                "title": "Juan Balvin",
                "address": null,
                "category": null,
                "username": "jbalvin",
                "has_story": false,
                "subcategory": null,
                "website_url": null,
                "display_name": "Juan Balvin",
                "subscriber_count": 0,
                "snapcode_image_url": null,
                "business_profile_id": "190b03c1-a4d3-4b2e-92d5-17f5bf93ea7b",
                "profile_picture_url": "https://cf-st.sc-cdn.net/aps/bolt/aHR0cHM6Ly9jZi1zdC5zYy1jZG4ubmV0L2QvWW1tSUZkY2JlZTNrZVl5bVlQbEpxP2JvPUVnMGFBQm9BTWdFRVNBSlFDR0FCJnVjPTg._RS0,640_FMpng",
                "creation_timestamp_ms": null,
                "has_curated_highlights": false,
                "has_spotlight_highlights": false,
                "last_update_timestamp_ms": null
            },
            {
                "id": null,
                "bio": null,
                "link": "https://www.snapchat.com/add/jlobts",
                "badge": 1,
                "title": "Jennifer Lopez",
                "address": null,
                "category": null,
                "username": "jlobts",
                "has_story": false,
                "subcategory": null,
                "website_url
…(truncated, see openapi.json for full schema)
```

### Spotlights

#### `GET /v1/spotlights/search` — Search spotlights

**Parameters:**
- `query` (query, required, string) — Search query Example: `jlo`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/snapchat-api/v1/spotlights/search?query=jlo"
```

**Response:**
```json
{
    "data": {
        "count": 24,
        "spotlights": [
            {
                "onTap": {
                    "action": {
                        "$case": "playStoryCard",
                        "playStoryCard": {
                            "storyId": "827dc3860c14559fd9922d9cd2dc43dd"
                        }
                    }
                },
                "ageText": "",
                "storyId": "827dc3860c14559fd9922d9cd2dc43dd",
                "mediaKey": "LtjdUUjPe2M+Bkj1urtFxqRigYuhH3AZiJaOvl595AA=",
                "mediaUrl": "https://bolt-gcdn.sc-cdn.net/z/H7A1mk5pLgIwohbgaFGo7.27.IRZXSOY?mo=GlAaCTIBeUgCUC5gAVoQU3BvdGxpZ2h0U2hhcmluZ6IBLAgbEhsKGQjIz1ogAUoPCgqWAVlUW1JWWlpbEPQDaAIiCxIAKgdJUlpYU09ZkAOyQQ%3D%3D&uc=46",
                "playCount": "",
                "rawSnapId": "W7_EDlXWTBiXAEEniNoMPwAAYdHlhbnJiYmphAZbbOAVQAZbbN_3KAAAAAQ",
                "teaserText": "",
                "creatorName": "",
                "thumbnailIv": "NzUfCFZJijByXisMOOdkKg==",
                "thumbnailUrl": "https://bolt-gcdn.sc-cdn.net/z/H7A1mk5pLgIwohbgaFGo7.1025?mo=Gh8aCTIBeUgCUC5gAVoIRGZGRnJhbWWiAQcIgQgiAhIA&uc=46",
                "creatorUsername": "",
                "creatorDisplayName": "",
                "creatorNameLogoUrl": "",
                "creatorNameDecorators": [],
                "teaserTextMaxNumLines": 0,
                "creatorNameMaxNumLines": 0,
                "bottomLeadingUiElements": []
            },
            {
         
…(truncated, see openapi.json for full schema)
```


---
Marketplace page: https://www.oanor.com/api/snapchat-api
OpenAPI spec: https://www.oanor.com/api/snapchat-api/openapi.json
