Welcome to the Shortfundly API

Beta

We try to have no breaking changes, but please don't expect this API to be completely frozen.

Privileges

By default all apps are read-only.

Please understand that we currently do not provide write access (e.g. creating upvotes for a user) to third party developers.

The Shortfundly API must not be used for commercial purposes. If you would like to use it for your business, please contact us at info@shortfundly.com

Accessing Endpoints

The API is reachable at https://api.shortfundly.com/v1/

Currently the API is only accessible with a provided access_token.

We reserve the right to rate-limit any application if we feel you are not following fair-use.

If you require faster access without rate limit please contact us.

Get started: Getting an OAuth2 token

Get a token on behalf of a user:

Follow the steps in OAuth User Authentication oauth#authorize to receive an access_grant

Use the access_grant in oauth#token

Add the Authentication HTTP header with the token to all requests

Test this and troubleshoot according to the examples in oauth#test
Get a token without user context. (eg before a user logs in)

Follow the steps explained in OAuth Client Only Authentication oauth#token

Please remember that these tokens limit you to public endpoints that don't require user context.

But… i just wanted to run a simple script?

The oauth2 flow is a bit of a overkill if you just want to run a few scripts

We provide a developer_token (does not expire, linked to your account) in the app dashboard

May I use the API for my business?

By default the Shortfundly API must not be used for commercial purposes. If you would like to use it for your business, please contact us at info@shortfundly.com

Done building? Get featured!

We’re excited to see what all you creative folks build and happy to feature your product on the site. Contact us at info@shortfundly.com with its name, a couple sentence description, and link to the project.

Do I have to attribute Shortfundly?

We kindly ask that you include attribution in your project, linking back to shortfundly. We’d also appreciate those that include a Shortfundly logo (it’s helpful for us!).

If you have any more questions, feedback, ideas or problems don’t hesitate to contact us! Also, let us know what you’re working on! Drop us a line at info@shortfundly.com.