Highlights

Saved story highlights, each with the snaps inside it. Use `limit` for how many.

POST /api/public/v1/scrape/snapchat/highlights

Returns highlight_tray_api

Parameters#

username string required

Snapchat username, with or without the @.

Example: nasa

limit integer optional

How many results you want. The run is sized from it, and you are billed for exactly that many.

Results#

GET /runs/:id/results answers with this once the run has finished — one highlight per row.

Every row also carries raw_json — the platform's own object for that row, exactly as it arrived, with nothing removed. It is left out of the example for length.

This endpoint errs towards returning more rather than less, so expect a few extra rows alongside what you asked for. Everything still comes back typed and parsed the same way.

curl -X POST https://socialholmes.com/api/public/v1/scrape/snapchat/highlights \
  -H "Authorization: Bearer $SOCIALHOLMES_KEY" \
  -H "Content-Type: application/json" \
  -d '{"parameters": {"username": "nasa"}, "limit": 25}'

import os
import requests

run = requests.post(
    "https://socialholmes.com/api/public/v1/scrape/snapchat/highlights",
    headers={"Authorization": f"Bearer {os.environ['SOCIALHOLMES_KEY']}"},
    json={"parameters": {"username": "nasa"}, "limit": 25},
).json()

print(run["id"], run["status"])

const response = await fetch("https://socialholmes.com/api/public/v1/scrape/snapchat/highlights", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SOCIALHOLMES_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ parameters: { username: "nasa" }, limit: 25 }),
})

const run = await response.json()
console.log(run.id, run.status)

require "net/http"
require "json"

response = Net::HTTP.post(
  URI("https://socialholmes.com/api/public/v1/scrape/snapchat/highlights"),
  { parameters: { username: "nasa" }, limit: 25 }.to_json,
  "Authorization" => "Bearer #{ENV.fetch('SOCIALHOLMES_KEY')}",
  "Content-Type" => "application/json"
)

run = JSON.parse(response.body)
puts run["id"], run["status"]

<?php

$ch = curl_init("https://socialholmes.com/api/public/v1/scrape/snapchat/highlights");

curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("SOCIALHOLMES_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(["parameters" => ["username" => "nasa"], "limit" => 25]),
]);

$run = json_decode(curl_exec($ch), true);

echo $run["id"], " ", $run["status"];

package main

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

func main() {
	body, _ := json.Marshal(map[string]any{
		"parameters": map[string]string{"username": "nasa"},
		"limit":      25,
	})

	req, _ := http.NewRequest("POST", "https://socialholmes.com/api/public/v1/scrape/snapchat/highlights", bytes.NewReader(body))
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SOCIALHOLMES_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	var run map[string]any
	json.NewDecoder(res.Body).Decode(&run)

	fmt.Println(run["id"], run["status"])
}

202 Accepted

{
  "id": "8f14e45f-ceea-467a-9c2e-1b0f5a4c7d21",
  "status": "queued",
  "platform": "snapchat",
  "endpoint": "highlights",
  "target": "nasa",
  "url": "https://www.snapchat.com/@nasa",
  "result_count": 0,
  "created_at": "2026-08-28T16:19:10Z"
}

example

{
  "run": {
    "id": "8f14e45f-ceea-467a-9c2e-1b0f5a4c7d21",
    "status": "succeeded",
    "platform": "snapchat",
    "endpoint": "highlights",
    "target": "nasa",
    "url": "https://www.snapchat.com/@nasa",
    "result_count": 1,
    "requested": 25,
    "estimated_cost": 125,
    "captures": 1,
    "created_at": "2026-08-22T09:11:03Z",
    "started_at": "2026-08-22T09:12:03Z",
    "finished_at": "2026-08-22T09:14:03Z"
  },
  "unit": "highlight",
  "results": [
    {
      "id": "highlight-artemis",
      "title": "Artemis",
      "story_type": "CURATED_HIGHLIGHT",
      "media_count": 1,
      "cover_url": "https://snapchat.example/img/highlight_artemis.jpg",
      "url": "https://www.snapchat.com/@nasa",
      "owner": {
        "username": "nasa",
        "url": "https://www.snapchat.com/@nasa"
      },
      "snaps": [
        {
          "media_type_id": "IMAGE",
          "media_urls": [
            "https://snapchat.example/media/hl_artemis_0.jpg"
          ],
          "index": 0
        }
      ]
    }
  ],
  "page": {
    "limit": 2,
    "offset": 0,
    "returned": 1,
    "total": 1
  }
}

Try it