Cosmos profile API
  1. Docs
  2. Cosmos
  3. Cosmos profile API

Cosmos profile API

A public Cosmos profile: bio, links and follower counts.

GET /v1/cosmos/profile

GET /v1/cosmos/profile

A public Cosmos profile: bio, links and follower counts.

  • Cost: 1 credit
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
handlestringyesCosmos username, without a profile URL. Also accepted as username.

Every request also accepts:

  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

1curl -G "https://api.socialscrape.dev/v1/cosmos/profile" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3  --data-urlencode "handle=design"

Example response#

This is a sample from a recorded response. Status 200.

200 OKSample response
1{2  "ok": true,3  "credits_charged": 1,4  "credits_remaining": 4999,5  "cached": false,6  "cached_at": null,7  "request_id": "req_0304466741894cf49031423a",8  "data": {9    "object": "profile",10    "platform": "cosmos",11    "id": "234172146",12    "handle": "design",13    "name": "Design",14    "headline": null,15    "url": "https://www.cosmos.so/design",16    "kind": "person",17    "bio": "where systems learn to speak to people",18    "avatar_url": "https://cdn.cosmos.so/e39a4934-53ae-4536-95a3-18ccd4d052a0",19    "banner_url": null,20    "verified": false,21    "is_private": null,22    "external_url": null,23    "links": null,24    "location": null,25    "category": null,26    "created_at": null,27    "stats": {28      "followers": 1003,29      "following": 1,30      "posts": 25,31      "likes": null,32      "views": null33    },34    "extra": {35      "collection_count": 70,36      "is_premium": true37    }38  },39  "cursor": null,40  "has_more": null41}

Response#

A Profile object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.

Example error:

1{2  "ok": false,3  "error": {4    "code": "not_found",5    "message": "The platform says this profile, post or item does not exist.",6    "retryable": false7  },8  "credits_charged": 0,9  "request_id": "req_aa120d8cad9431302017a2cf"10}