Introducing Backtick API: An open-source, unofficial Tildes API

wababa
Tue, 01 Aug 2023 15:26:42 +0000

Hi everyone! Today I am releasing Backtick API, an unofficial Tildes API. I originally wrote it to power Backtick but quickly realized that it could be useful for other clients and projects that require Tildes data. The project is open-sourced, both because I would love community contributions and because I want to make the project as transparent as possible.

Q: Does it require or store any user credentials?

No. All the endpoints that are implemented scrape publicly available data that do not require any user credentials.

Q: Will this overload Tildes?

To prevent Backtick API from being a nuisance to Tildes, the code caches calls to Tildes for a short period of time. Depending on usage, it should reduce the number of calls to Tildes (vs a client querying Tildes directly).

Q: How can I use it?

A hosted version of the code is available through RapidAPI here: https://rapidapi.com/asnewman/api/backtick-api

Q: Are there any limitations?

To prevent the project from being abused and becoming a financial burden on myself, I'm using RapidAPI to manage usage. There is a generous free tier and a reasonably priced paid tier which will be used to cover server costs. In addition, I will be donating a portion of the paid plan revenue (my goal is 50% but will depend on load and subscription count) directly to Tildes via Github Sponsors. It's really important to me to keep this project and Tildes as sustainable as possible. I really would love to provide everything for free, but unfortunately, there are countless examples where that doesn't work out down the road.

Of course, if you do not want to use the hosted version, you are welcome to deploy the code yourself!

Q: Isn't scraping prone to breaking?

Yes! Users beware! Obviously, I will try my best to fix things if the Tildes code changes in a way that breaks Backtick API, but it's definitely a possibility.

Q: Why not just work on and contribute to creating an official Tildes API?

An official Tildes API will always be better than something like this and I look forward to when/if it gets implemented. That being said, I'm choosing the route that would be the quickest to continue the development of the Backtick mobile app. In addition, it's also the choice that is most fun for me. To work on a Tildes API, if the powers that be even want to have one, would require lots of coordination and codebase learning, something that will take a lot of time. I highly commend anyone who chooses to take on that task, but I do too much of that kind of work for my real job 😂

Please report any issues or feature requests through Github, this post, or the Backtick Discord server. Finally, I just want to thank everyone in the community for all the great conversations I've had, for providing helpful feedback for Backtick, and for creating a place on the internet that I very much enjoy being a part of 😊

Comments URL: https://tildes.net/~tildes/18xa/introducing_backtick_api_an_open_source_unofficial_tildes_api

Votes: 59

Comments: 9