Get a Cosmos collection

Try in Playground

Retrieve a collection’s name, description, cover image, owner, element and follower counts, and subcollections. Accept a collection or subcollection URL.

GET/v1/cosmos/clusterx-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 cosmos.so collection URL with a username, collection slug and optional subcollection slug; maximum URL length 1,500 characters. Tracking query parameters are removed.

max 1500 chars

Examplehttps://www.cosmos.so/example/design-references

Response fields

idinteger

Numeric Cosmos collection ID.

≥ 0

namestring

Collection name.

slugstring

Collection URL slug.

descriptionstringnullable

Published collection description, or null.

urlstring

Required HTTPS cosmos.so collection URL with a username, collection slug and optional subcollection slug; maximum URL length 1,500 characters. Tracking query parameters are removed.

absolute HTTPS URL

cover_image_urlstringnullable

Published cover image URL, or null.

post_countintegernullable

Published saved-element count, or null.

≥ 0

follower_countintegernullable

Published collection follower count, or null.

≥ 0

Public collection owner details.

owner.idinteger

Numeric Cosmos owner ID.

≥ 0

owner.usernamestring

Owner’s Cosmos username.

owner.full_namestringnullable

Owner’s published display name, or null.

owner.avatar_urlstringnullable

Owner’s public avatar URL, or null.

requestIdstring

Request correlation UUID.

Source request attempts, decoded bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Number of upstream request attempts.

≥ 0

accounting.responseBytesinteger

Decoded source bytes read during this request.

≥ 0

accounting.durationMsnumber

Elapsed request time in milliseconds.

≥ 0

successboolean

True when usable data is returned; inspect status and coverage.

statusenum

success or partial for usable data; failed or challenged for a failure response.

one of: success, partial

sourceUrlstring

Canonical Cosmos URL for the requested profile, element, collection or search.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Returned-result coverage and extraction warnings.

coverage.sourcestring

Public Cosmos API data.

coverage.completeboolean

Whether the returned result has no reported omissions.

coverage.warningsstring[]

Warnings explaining partial results or truncated fields.

Public subcollections in source order.

up to 40 items

subcollections.idinteger

Numeric Cosmos collection ID.

≥ 0

subcollections.namestring

Collection name.

subcollections.slugstring

Collection URL slug.

subcollections.descriptionstringnullable

Published collection description, or null.

subcollections.urlstring

Canonical public collection URL.

absolute HTTPS URL

subcollections.cover_image_urlstringnullable

Published cover image URL, or null.

subcollections.post_countintegernullable

Published saved-element count, or null.

≥ 0

subcollections.follower_countintegernullable

Published collection follower count, or null.

≥ 0

Public collection owner details.

subcollections.owner.idinteger

Numeric Cosmos owner ID.

≥ 0

subcollections.owner.usernamestring

Owner’s Cosmos username.

subcollections.owner.full_namestringnullable

Owner’s published display name, or null.

subcollections.owner.avatar_urlstringnullable

Owner’s public avatar URL, or null.

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
200	`partial`	Usable data with media_incomplete, media_limit, restricted_subcollections_omitted, subcollections_incomplete, subcollection_limit or record_limit coverage warnings.
400	`invalid_request`	Missing, duplicate, malformed, unsafe or unsupported request parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The requested Cosmos content is not publicly accessible.
404	`not_found`	The requested public profile, element or collection was not found.
429	`upstream_rate_limited`	Cosmos temporarily rate-limited retrieval.
502	`upstream_challenged`	Cosmos challenged retrieval.
502	`upstream_error`	Source retrieval could not complete.
502	`unsupported_page`	The source response was incomplete, mismatched or unsupported.
502	`response_too_large` `payload_too_complex`	Source data exceeded the byte or parsing limits.
502	`unsafe_redirect` `request_limit`	The source redirect or request sequence exceeded the accepted contract.
503	`busy`	All Cosmos retrieval slots are in use.
504	`timeout`	The total operation deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/cosmos/cluster?url=https%3A%2F%2Fwww.cosmos.so%2Fexample%2Fdesign-references" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/cosmos/cluster?url=https%3A%2F%2Fwww.cosmos.so%2Fexample%2Fdesign-references",
  {
    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/cosmos/cluster?url=https%3A%2F%2Fwww.cosmos.so%2Fexample%2Fdesign-references",
  {
    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(`Cosmos request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/cosmos/cluster",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://www.cosmos.so/example/design-references"
    },
    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/cosmos/cluster?url=https%3A%2F%2Fwww.cosmos.so%2Fexample%2Fdesign-references", 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/cosmos/cluster?url=https%3A%2F%2Fwww.cosmos.so%2Fexample%2Fdesign-references"))
            .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-000000000001",
  "sourceUrl": "https://www.cosmos.so/example/design-references",
  "fetchedAt": "2026-10-06T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 2500,
    "durationMs": 300
  },
  "id": 201,
  "name": "Design References",
  "slug": "design-references",
  "description": "Synthetic design reference collection.",
  "url": "https://www.cosmos.so/example/design-references",
  "cover_image_url": "https://example.test/cover.jpg",
  "post_count": 5,
  "follower_count": 12,
  "owner": {
    "id": 101,
    "username": "example",
    "full_name": "Example Curator",
    "avatar_url": "https://example.test/avatar.png"
  },
  "subcollections": []
}

Missing, duplicate, malformed, unsafe or unsupported request 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."
  }
}