Skip to content
An unofficial API to interface with floatplane.com from own systems. This is not in any way affiliated with floatplane.com.
TypeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
functions
.babelrc
.gitignore
404.json
DEVELOPER_README.md
LICENSE
README.md
_headers
_redirects
netlify.toml
package.json
tsconfig.json

README.md

FloatplaneAPI

An unofficial API to interface with floatplane.com from own systems. This is not in any way affiliated with floatplane.com / Floatplane Media.

Q&A

What does this do?

floatplaneapi.com is a way to interface with the Floatplane backend service. It will be able to serve all information that is currently available to the client floatplane.com frontend.

What API calls are currently supported?

Below are all the request types we support now (ticked) and the ones that we want to implement (not ticked). If we missed anything please PR or open an issue.

  • Users
    • Login w/ Username Password
      • 2FA
    • Get self
    • Get user info
    • Check if admin
    • Check if creator
    • Get subscriptions
    • Get ID from name
    • Get activity
  • Creators
    • Get videos
    • Get info
    • Get ID from name
  • Videos
    • Get info
    • Get related videos
    • Comments
      • Get comments
      • Place comments
      • Like comment
      • Dislike comment
      • Clear like on comment
    • Stream (m3u8)
    • Download (mp4)
  • Edges
    • List edges
  • Livestream
    • Video
    • Chat

We are not planning to support anything to do with payments and subscribing/canceling. We will close any and all PRs and issues related to this.

I am Floatplane Media and would like to get the floatplaneapi.com domain! Where can I get it?

Sure! No problem. Shoot me a message on Twitter @creativeguy2013 and ill transfer the domain ASAP. :-)

How to use

Check out the docs: https://docs.floatplaneapi.com/rest-api/getting-started

Licence

We use the MIT Licence. You can find it in the LICENCE file. This approximately means you are free to do whatever you want with the project as long as you don't sue us if something doesn't work or is not as you like.

You can’t perform that action at this time.