`) tags surrounding it, along with other HTML.. - **type** (string (blogPost)) (required) ("blogPost") - **channel** (object) (required) - **id** (string) (required) - **creator** (string) (required) - **title** (string) (required) - **urlname** (string) (required): Shown in the browser URL. - **about** (string) (required) - **order** (integer) - **cover** (object) (required) - **width** (integer) (required) - **height** (integer) (required) - **path** (string (uri)) (required) - **childImages** (array (object)) (required) Array items: - **width** (integer) (required) - **height** (integer) (required) - **path** (string (uri)) (required) - **card** (object) (required) - **icon** (object) (required) - **socialLinks** (object) - **tags** (array (string)) (required) - **attachmentOrder** (array (string)) (required) - **metadata** (object) (required) - **hasVideo** (boolean) (required) - **videoCount** (integer) - **videoDuration** (number) (required) - **hasAudio** (boolean) (required) - **audioCount** (integer) - **audioDuration** (number) (required) - **hasPicture** (boolean) (required) - **pictureCount** (integer) - **hasGallery** (boolean) - **galleryCount** (integer) - **isFeatured** (boolean) (required) - **releaseDate** (string (date-time)) (required) - **likes** (integer) (required) - **dislikes** (integer) (required) - **score** (integer) (required) - **comments** (integer) (required) - **creator** (object) (required) - **id** (string) (required) - **owner** (object) (required) - **id** (string) (required) - **username** (string) (required) - **title** (string) (required) - **urlname** (string) (required): Shown in the browser URL, and used in `/creator/named` queries. - **description** (string) (required) - **about** (string) (required) - **category** (object) (required) - **id** (string) (required) - **title** (string) (required) - **cover** (object) (required) - **icon** (object) (required) - **liveStream** (object) (required) - **id** (string) (required) - **title** (string) (required) - **description** (string) (required) - **thumbnail** (object) (required) - **owner** (string) (required) - **channel** (string): The creator channel this livestream belongs to. - **streamPath** (string) (required) - **offline** (object) (required) - **title** (string) (required) - **description** (string) (required) - **thumbnail** (object) (required) - **subscriptionPlans** (array (object)) (required) Array items: - **id** (string) (required) - **title** (string) (required) - **description** (string) (required) - **price** (string) (required) - **priceYearly** (string) - **currency** (string) (required) - **logo** (string) (required) - **interval** (string) (required) - **featured** (boolean) (required) - **allowGrandfatheredAccess** (boolean) - **discordServers** (array (object)) (required) Array items: - **id** (string) (required) - **guildName** (string) (required) - **guildIcon** (string) (required) - **inviteLink** (string (uri)) (required) - **inviteMode** (string) (required) - **discordRoles** (array (object)) (required) Array items: - **server** (string) (required) - **roleName** (string) (required) - **discoverable** (boolean) (required) - **subscriberCountDisplay** (string) (required) - **incomeDisplay** (boolean) (required) - **defaultChannel** (string) - **channels** (array (string)) - **card** (object) - **wasReleasedSilently** (boolean) (required) - **thumbnail** (object) - **isAccessible** (boolean) (required): If false, the post should be marked as locked and not viewable by the user. - **videoAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. - **audioAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. - **pictureAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. - **galleryAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. - **lastElements** (array (object)) (required): Information about paging: what the last ID retrieve is and if more posts can be retrieved afterward for subsequent requests. Array items: - **creatorId** (string) (required) - **blogPostId** (string) (required): This may be returned as `null` if no blog posts for this creator appeared yet on this page of blog posts. However, Floatplane will complain if this is sent with a `null` value. - **moreFetchable** (boolean) (required) #### 400 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 401 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 403 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 404 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 429 - response #### default - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. ### Example Usage ```bash curl -X GET "https://www.floatplane.com/api/v3/content/creator/list?ids=item1,item2&limit=0&fetchAfter=item1,item2" ``` ``` -------------------------------- ### GET /api/v3/content/creator Source: https://jamamp.github.io/FloatplaneAPIDocs/floatplane-openapi-specification-trimmed.json Retrieve a paginated list of blog posts from a creator. Or search for blog posts from a creator. Example query: https://www.floatplane.com/api/v3/content/creator?id=59f94c0bdd241b70349eb72b&fromDate=2021-07-24T07:00:00.001Z&toDate=2022-07-27T06:59:59.099Z&hasVideo=true&hasAudio=true&hasPicture=false&hasText=false&fromDuration=1020&toDuration=9900&sort=DESC&search=thor&tags[0]=tjm ```markdown ### Parameters - **id** (string, query, required): The GUID of the creator to retrieve posts from. - **channel** (string, query, optional): The id of a creator's specific channel from which to retrieve posts. - **limit** (integer, query, optional): The maximum number of posts to return. - **fetchAfter** (integer, query, optional): The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. - **search** (string, query, optional): Search filter to look for specific posts. - **tags** (array (string), query, optional): An array of tags to search against, possibly in addition to `search`. - **hasVideo** (boolean, query, optional): If true, include blog posts with video attachments. - **hasAudio** (boolean, query, optional): If true, include blog posts with audio attachments. - **hasPicture** (boolean, query, optional): If true, include blog posts with picture attachments. - **hasText** (boolean, query, optional): If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery. This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results. - **sort** (string (ASC|DESC), query, optional): `DESC` = Newest First. `ASC` = Oldest First. - **fromDuration** (integer, query, optional): Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. - **toDuration** (integer, query, optional): Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. - **fromDate** (string (date-time), query, optional): Include posts where the publication date is on or after this filter date. - **toDate** (string (date-time), query, optional): Include posts where the publication date is on or before this filter date. ### Responses #### 200 - OK - Creator posted returned - Array of object - **id** (string) (required) - **guid** (string) (required) - **title** (string) (required) - **text** (string) (required): Text description of the post. May have HTML paragraph (`
`) tags surrounding it, along with other HTML.. - **type** (string (blogPost)) (required) ("blogPost") - **channel** (object) (required) - **id** (string) (required) - **creator** (string) (required) - **title** (string) (required) - **urlname** (string) (required): Shown in the browser URL. - **about** (string) (required) - **order** (integer) - **cover** (object) (required) - **width** (integer) (required) - **height** (integer) (required) - **path** (string (uri)) (required) - **childImages** (array (object)) (required) Array items: - **width** (integer) (required) - **height** (integer) (required) - **path** (string (uri)) (required) - **card** (object) (required) - **icon** (object) (required) - **socialLinks** (object) - **tags** (array (string)) (required) - **attachmentOrder** (array (string)) (required) - **metadata** (object) (required) - **hasVideo** (boolean) (required) - **videoCount** (integer) - **videoDuration** (number) (required) - **hasAudio** (boolean) (required) - **audioCount** (integer) - **audioDuration** (number) (required) - **hasPicture** (boolean) (required) - **pictureCount** (integer) - **hasGallery** (boolean) - **galleryCount** (integer) - **isFeatured** (boolean) (required) - **releaseDate** (string (date-time)) (required) - **likes** (integer) (required) - **dislikes** (integer) (required) - **score** (integer) (required) - **comments** (integer) (required) - **creator** (object) (required) - **id** (string) (required) - **owner** (object) (required) - **id** (string) (required) - **username** (string) (required) - **title** (string) (required) - **urlname** (string) (required): Shown in the browser URL, and used in `/creator/named` queries. - **description** (string) (required) - **about** (string) (required) - **category** (object) (required) - **id** (string) (required) - **title** (string) (required) - **cover** (object) (required) - **icon** (object) (required) - **liveStream** (object) (required) - **id** (string) (required) - **title** (string) (required) - **description** (string) (required) - **thumbnail** (object) (required) - **owner** (string) (required) - **channel** (string): The creator channel this livestream belongs to. - **streamPath** (string) (required) - **offline** (object) (required) - **title** (string) (required) - **description** (string) (required) - **thumbnail** (object) (required) - **subscriptionPlans** (array (object)) (required) Array items: - **id** (string) (required) - **title** (string) (required) - **description** (string) (required) - **price** (string) (required) - **priceYearly** (string) - **currency** (string) (required) - **logo** (string) (required) - **interval** (string) (required) - **featured** (boolean) (required) - **allowGrandfatheredAccess** (boolean) - **discordServers** (array (object)) (required) Array items: - **id** (string) (required) - **guildName** (string) (required) - **guildIcon** (string) (required) - **inviteLink** (string (uri)) (required) - **inviteMode** (string) (required) - **discordRoles** (array (object)) (required) Array items: - **server** (string) (required) - **roleName** (string) (required) - **discoverable** (boolean) (required) - **subscriberCountDisplay** (string) (required) - **incomeDisplay** (boolean) (required) - **defaultChannel** (string) - **channels** (array (string)) - **card** (object) - **wasReleasedSilently** (boolean) (required) - **thumbnail** (object) - **isAccessible** (boolean) (required): If false, the post should be marked as locked and not viewable by the user. - **videoAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. - **audioAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. - **pictureAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. - **galleryAttachments** (array (string)): May be undefined, usually when `isAccessible` is `false`. #### 400 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 401 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 403 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 404 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 429 - response #### default - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. ### Example Usage ```bash curl -X GET "https://www.floatplane.com/api/v3/content/creator?id=string&channel=string&limit=0&fetchAfter=0&search=string&tags=item1,item2&hasVideo=true&hasAudio=true&hasPicture=true&hasText=true&sort=ASC&fromDuration=0&toDuration=0&fromDate=2023-01-01T00:00:00Z&toDate=2023-01-01T00:00:00Z" ``` ``` -------------------------------- ### GET /api/v3/creator/info Source: https://jamamp.github.io/FloatplaneAPIDocs/floatplane-openapi-specification-trimmed.json Retrieve detailed information about a specific creator. ```markdown ### Parameters - **id** (string, query, required): The GUID of the creator being searched. ### Responses #### 200 - OK - Creator information returned **CreatorModelV3** - **id** (string) (required) - **owner** (object) (required) - **id** (string) (required) - **username** (string) (required) - **title** (string) (required) - **urlname** (string) (required): Shown in the browser URL, and used in `/creator/named` queries. - **description** (string) (required) - **about** (string) (required) - **category** (object) (required) - **id** (string) (required) - **title** (string) (required) - **cover** (object) (required) - **width** (integer) (required) - **height** (integer) (required) - **path** (string (uri)) (required) - **childImages** (array (object)) (required) Array items: - **width** (integer) (required) - **height** (integer) (required) - **path** (string (uri)) (required) - **icon** (object) (required) - **liveStream** (object) (required) - **id** (string) (required) - **title** (string) (required) - **description** (string) (required) - **thumbnail** (object) (required) - **owner** (string) (required) - **channel** (string): The creator channel this livestream belongs to. - **streamPath** (string) (required) - **offline** (object) (required) - **title** (string) (required) - **description** (string) (required) - **thumbnail** (object) (required) - **subscriptionPlans** (array (object)) (required) Array items: - **id** (string) (required) - **title** (string) (required) - **description** (string) (required) - **price** (string) (required) - **priceYearly** (string) - **currency** (string) (required) - **logo** (string) (required) - **interval** (string) (required) - **featured** (boolean) (required) - **allowGrandfatheredAccess** (boolean) - **discordServers** (array (object)) (required) Array items: - **id** (string) (required) - **guildName** (string) (required) - **guildIcon** (string) (required) - **inviteLink** (string (uri)) (required) - **inviteMode** (string) (required) - **discordRoles** (array (object)) (required) Array items: - **server** (string) (required) - **roleName** (string) (required) - **discoverable** (boolean) (required) - **subscriberCountDisplay** (string) (required) - **incomeDisplay** (boolean) (required) - **defaultChannel** (string) (required) - **socialLinks** (object) (required) - **channels** (array (object)) (required) Array items: - **id** (string) (required) - **creator** (string) (required) - **title** (string) (required) - **urlname** (string) (required): Shown in the browser URL. - **about** (string) (required) - **order** (integer) - **cover** (object) (required) - **card** (object) (required) - **icon** (object) (required) - **socialLinks** (object) - **discordServers** (array (object)): Present in `/creator/named` queries Array items: - **card** (object) #### 400 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 401 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 403 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 404 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 429 - response #### default - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. ### Example Usage ```bash curl -X GET "https://www.floatplane.com/api/v3/creator/info?id=string" ``` ``` -------------------------------- ### POST /api/v3/content/get/progress Source: https://jamamp.github.io/FloatplaneAPIDocs/floatplane-openapi-specification-trimmed.json Batch retrieval of watch progress values for blog posts. This API is useful for showing progress of a list of blog posts shown on the screen to the user. When retrieving a list of blog posts, the media attachments only include the identifier; when retrieving full details of a blog post, the attachments include more information, but still fail to return the progress of the media. Only when pulling the full video/audio content does the progress get included in the response. Thus, the recommended approach is to pull paginated results of blog posts first, as usual, and then to call this endpoint to retrieve progress values for each blog post to show in some capacity, usually on the thumbnail as a progress bar on the bottom. Note that the progress values returned in this endpoint are different from the update progress endpoint and the values returned in video/audio attachments. While the latter are measured in seconds, this endpoint returns progress as a percentage of the media's total duration. It is presumed that the progress returned is from the first attachment in the blog post's `attachmentOrder` that is either a video or audio attachment. Because this returns progress as an integer percentage (0 to 100), it is not recommended to use this particular value for jumping to a timestamp in the media when resuming playback, as the rounded number may be off by plus/minus several seconds in actual playback. Use the actual attachment progress, measured in seconds, instead. ```markdown ### Request Body **Content-Type:** application/json - **ids** (array (string)) (required): The identifiers of the blog posts from which progress should be retrieved. - **contentType** (string (blogPost)) (required): The type of the corresponding identifiers. The only value currently is `blogPost`. ("blogPost") ### Responses #### 200 - OK **GetProgressResponse** - Array of object - **id** (string) (required) - **progress** (integer) (required): Percentage of the blog post's media that has been consumed so far. Ranges from 0 to 100. #### 400 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 401 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 403 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 404 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 429 - response #### default - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. ### Example Usage ```bash curl -X POST "https://www.floatplane.com/api/v3/content/get/progress" \ -H "Content-Type: application/json" \ -d '{ "ids": [ "string" ], "contentType": "blogPost" }' ``` ``` -------------------------------- ### GET /api/v2/connect/list Source: https://jamamp.github.io/FloatplaneAPIDocs/floatplane-openapi-specification-trimmed.json List the available 3rd party accounts for the user's profile. ```markdown ### Responses #### 200 - OK - Returns the list of connected and available accounts. - Array of object - **key** (string) (required): Unique identifier for the account type. - **name** (string) (required): Display-friendly label for the `key`. - **enabled** (boolean) (required): Determines if the system allows this account to be connected to. - **iconWhite** (string) (required) - **connectedAccount** (object) (required) - **id** (string) (required) - **remoteUserId** (string) (required) - **remoteUserName** (string) (required) - **data** (object) (required) - **canJoinGuilds** (boolean) (required) - **connected** (boolean) (required): If true, the user is connected and the `connectedAccount` will have data about the account. - **isAccountProvider** (boolean) (required) #### 400 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 401 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 403 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 404 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 429 - response #### default - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. ### Example Usage ```bash curl -X GET "https://www.floatplane.com/api/v2/connect/list" ``` ``` -------------------------------- ### GET /api/v3/auth/captcha/info Source: https://jamamp.github.io/FloatplaneAPIDocs/floatplane-openapi-specification-trimmed.json Gets the site keys used for Google Recaptcha V2 and V3. These are useful when providing a captcha token when logging in or signing up. ```markdown ### Responses #### 200 - OK **GetCaptchaInfoResponse** - **v2** (object) (required) - **variants** (object) (required) - **android** (object) (required) - **siteKey** (string) (required) - **checkbox** (object) (required) - **invisible** (object) (required) - **v3** (object) (required) - **variants** (object) (required) - **invisible** (object) (required) #### 400 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 401 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 403 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 404 - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. #### 429 - response #### default - response **ErrorModel** - **id** (string) (required) - **errors** (array (object)) (required) Array items: - **id** (string) (required) - **name** (string) (required) - **message** (string): May be undefined. - **data** (object): May be undefined. - **message** (string): May be undefined. ### Example Usage ```bash curl -X GET "https://www.floatplane.com/api/v3/auth/captcha/info" ``` ``` -------------------------------- ### Schema: CdnDeliveryV3MediaBitrateInfo Source: https://jamamp.github.io/FloatplaneAPIDocs/floatplane-openapi-specification-trimmed.json Schema definition for CdnDeliveryV3MediaBitrateInfo ```markdown ## Schema: CdnDeliveryV3MediaBitrateInfo Schema definition for CdnDeliveryV3MediaBitrateInfo **Type:** object - **bitrate** (object) - **maximum** (number): Maximum bitrate observed for the data stream. - **average** (number): Average bitrate observed for the data stream. ```