Skip to content

Stories, WIP ​

NOTE

This page is a work in progress. Endpoints below haven't been fully researched.

Create story, WIP ​

Requires Authorization.

POST /v1/stories

Body:

  • mediaId — long integer
  • caption — string, optional
  • audience — object
    • options — array of strings, ["EVERYONE"] or any of "NEARBY", "FAVORITES", "MESSAGED", "ALBUM_SHARED"
    • myType — object, optional
      • ageMin — integer, optional
      • ageMax — integer, optional
      • positions — array of sexual position IDs, optional

Get stories inbox, WIP ​

Requires Authorization.

Profiles with active stories.

GET /v1/stories/inbox

Query (optional):

  • pageNumber — integer, starts at 1, optional
  • pageSize — integer, number of posters per page, optional

Response:

  • posters — array of objects or null

Errors:

  • 404 — Returned with an empty body; appears to mean Stories are not enabled for the account (no stories-v1 assignment).

Get my stories, WIP ​

Requires Authorization.

GET /v1/stories/mine

Response:

  • stories — array of objects or null
    • id — long integer
    • status — string, "PENDING", "ACTIVE", "REJECTED", "EXPIRED" or null
    • media — StoryMedia or null
    • caption — object or null
      • text — string or null
      • textStatus — string, "AWAITING_MODERATION", "MODERATION_APPROVED", "MODERATION_FAILED" or null
      • rejectReasons — array of strings: "BULLYING", "SELF_HARM", "DRUG_PATTERNS", "HATE_SPEECH", "SOL_SEX", "SPAM_DISRUPT", "UNDERAGE" or null
    • posted — unix timestamp in milliseconds or null
    • expiration — unix timestamp in milliseconds or null

Errors:

  • 404 — Returned with an empty body; appears to mean Stories are not enabled for the account (no stories-v1 assignment).

Get story ​

Requires Authorization.

GET /v1/stories/{storyId}

Response:

Errors:

  • 404 — Story not found or no longer available.

Delete story ​

Requires Authorization.

DELETE /v1/stories/{storyId}

Record story view ​

Requires Authorization.

POST /v1/stories/{storyId}/views

Get story reactions ​

Requires Authorization.

Lists the reactions that can be sent to a story.

GET /v1/stories/reactions

Response:

  • reactions — array of objects
    • reactionId — string, sent back as reactionId of a SendStoryReactionBody
    • unicode — string, appears to be space-separated code points such as U+1F525

Get profile stories, WIP ​

Requires Authorization.

GET /v1/stories/profiles/{profileId}

StoryMedia ​

  • mediaId — long integer, optional
  • thumbnailUrl — string, optional
  • fullImageUrl — string, optional
  • state — string, "PENDING", "APPROVED", "REJECTED", "DELETED" or null, optional
  • reason — string or null, optional
  • isRejectAutomated — boolean or null, optional
  • shouldBlur — boolean, optional
  • isNsfw — boolean, optional

Story ​

  • id — long integer, optional
  • profileId — long integer, optional
  • displayName — string or null, optional
  • mediaHash — string, See Media -> Public CDN files -> Profile Images or null, optional
  • onlineUntil — unix timestamp in milliseconds or null, optional
  • distance — integer, appears to be in meters or null, optional
  • media — StoryMedia or null, optional
  • caption — object or null, optional
    • text — string or null
  • posted — unix timestamp in milliseconds or null, optional
  • expiration — unix timestamp in milliseconds or null, optional
  • viewed — boolean, optional