Twitter API examples & templates
<3 Val Town
Val Town is my new favourite thing. Never heard of it ?
Well, according to it's homepage, Val Town is a social website to write and deploy TypeScript. It's often introduced as zappier for developers, or twitter for code.
The idea is simple: you write down a javascript snippet (named vals) in your browser, and it's instantly executed on a server. You can use it to:
- execute a function on a cron schedule
- host a small websites (this article hosted on Val Town)
- send yourself emails
- ...
But there is more to Val Town than this. If you take a look at the trending vals, you will quickly notice a pattern: most of the vals are about Val Town itself. People are using Val Town to extend Val Town, and it's fascinating to see what they come up with.
I've built a few of these extensions myself, and this article is about one of them.
Fixing the Val Town Search
Val.town is built around the http import feature of Deno. Each val is a standalone module, that you can import in other vals. It works both for your own vals, and for the vals of other users.
All of this is great, but there is one big issue: the search feature is terrible. It only works for exact text matches, and there is no way to set any filters based on username
, creation_date
, or anything else. This makes it really hard to find a val you are looking for, even if you are the one who wrote it.
In any other platform, I would have just given up and moved on. But Val Town is different. I was confident that I could address this issue in userspace, without having to wait for the platform to implement it.
Val Town allows you to run a val on a cron schedule, so I wrote a val that would fetch all the vals from the API, and store them as a sqlite table (did I mention that every user get it's own sqlite database ?).
Create valconst createQuery = `CREATE TABLE IF NOT EXISTS vals (
...
);`;
// run every hour
export default function(interval: Interval) {
// create the val table
await options.sqlite.execute(createQuery);
let url = "https://api.val.town/v1/search/vals?query=%20&limit=100";
// fetch all vals, and store them in the sqlite table
while (true) {
const resp = await fetch(url);
if (!resp.ok) {
throw new Error(await resp.text());
}
const res = await resp.json();
const rows = res.data.map(valToRow);
await insertRows(rows, options);
if (!res.links.next) {
break;
}
url = res.links.next;
}
}
Once the val had finished running, I had a table with all the vals from the platform. I could now run queries on this table to find the vals I was looking for.
Create valimport { sqlite } from "https://esm.town/v/std/sqlite"
const res = await sqlite.execute(`SELECT * FROM vals WHERE author = 'pomdtr' && code LIKE '%search%'`);
Of course I could have stopped there, but I wanted to go further. I wanted to share this table with other users, so they could run their own queries on it.
Isolating the Vals Table
There was still a challenge to overcome: the table was part of my account database, and I didn't want to give everyone access to it (there are some sensitive tables in there).
One way to solve this issue would be to publish a stripped-down api that only allows a few predefined queries. But that would be boring, and I wanted to give users the full power of SQL.
So I decided to isolate the val table in a separate account. There is a neat trick to achieve this on val.town: each val get's it own email address, and email sent to vals can be forwarded to your own email address.
Create valimport { email as sendEmail } from "https://esm.town/v/std/email?v=11";
// triggered each time an email is sent to pomdtr.sqlite_email@valtown.email
export default async function(email: Email) {
// forward the email to my own email address
await sendEmail({
subject: email.subject,
html: email.html,
text: email.text,
});
}
Since val.town account can be created with a val.email address, you can create an infinite number of accounts (and thus sqlite databases) using this trick.
So say hello to the sqlite account, which is a separate account that only contains the vals
table.
After creating the account, I just needed to fork the cron val from my main account to get a copy of the vals
table in the sqlite
account.
Publishing the Table
The val.town stdlib provides a neat rpc
function that provides a simple way to expose a function as an API. So I decided to write a simple val that would run a query on the table, and return the result.
Create valimport { rpc } from "https://esm.town/v/std/rpc?v=5";
import { InStatement, sqlite } from "https://esm.town/v/std/sqlite?v=4";
// rpc create an server, exposed on the val http endpoint
export default rpc(async (statement: InStatement) => {
try {
// run the query, then return the result as json
return await sqlite.execute(statement);
} catch (e) {
throw new Response(e.message, {
status: 500,
});
}
});
Everyone can now run queries on the table thanks a publically accessible endpoint (you even have write access to it, but I trust you to not mess with it).
You can test it locally using curl
and jq
:
echo "SELECT * FROM vals WHERE lower(name) LIKE '%feed%' and lower(name) like '%email%' LIMIT 100" | jq -R '{args: [.]} ' | xargs -0 -I {} curl -X POST "https://sqlite-execute.web.val.run" -H "Content-Type: application/json" -d {} | jq
Of course I don't expect the average val.town user to use shell commands to run queries, so I also built an helper val to interact with the API, allowing users to run queries from their own vals.
Create val// only the import changed from the previous example
import { db } from "https://esm.town/v/sqlite/db";
// this query will run on the `sqlite` account
const res = await db.execute(`SELECT * FROM vals WHERE author = 'pomdtr' && code LIKE '%search%'`);
I've seen some really cool vals built on top of this API. Someone even wrote down a guide to help users interact with it from the command-line!
I hope that someone will build an search UI to interact with it at some point, but in the meantime, you can use a community-contributed sqlite web interface to run queries on top of the vals
table.
Val.town as a code-taking app
As I've tried to show, having both a runtime, an editor and an API on the same platform is quite a magic formula. It's probably why val.town resonates so much with me.
Using CodeSandbox, Stackblitz, Repl.it, Gitpod, Github Codespaces or Gitpod feels pretty much the same, everything still revolves around the same concept of a project/repository. They feel uninspired somehow, trying to replicate the desktop IDE experience in the browser, instead of embracing the new possibilities that the web platform offers.
Val.town breaks this mold. I see it as a code-taking app, a place where I can just dump my ideas without worrying about the usual frictions of writing and deploying code.
Twitter 𝕏 keyword Alerts
Custom notifications for when you, your company, or anything you care about is mentioned on Twitter.
1. Authentication
You'll need a Twitter Bearer Token. Follow these instructions to get one.
Unfortunately it costs $100 / month to have a Basic Twitter Developer account. If you subscribe to Val Town Pro, I can let you "borrow" my token. Just comment on this val and I'll hook you up.
2. Query
Change the query
variable for what you want to get notified for.
You can use Twitter's search operators to customize your query, for some collection of keywords, filtering out others, and much more!
3. Notification
Below I'm sending these mentions to a private channel in our company Discord, but you can customize that to whatever you want, @std/email, Slack, Telegram, whatever.
Create your own Myspace profile, deployed to Val town. https://jdan-myspace.web.val.run
Click "..." and select Fork to create your own.
From there you can:
- Customize your own profile
- Or post on my wall by appending to
messages
and sending me a pull request
Create your own Myspace profile, deployed to Val town. https://jdan-myspace.web.val.run
Click "..." and select Fork to create your own.
From there you can:
- Customize your own profile
- Or post on my wall by appending to
messages
and sending me a pull request
Create your own Myspace profile, deployed to Val town. https://jdan-myspace.web.val.run
Click "..." and select Fork to create your own.
From there you can:
- Customize your own profile
- Or post on my wall by appending to
messages
and sending me a pull request
stevekrouse.com - my personal website
This val hosts my personal website. The view data is stored in Val Town SQLite - @std/sqlite.
It used to live on Github Pages, which is why I proxy over requests to certain blog posts over to the Github Pages site still.
Todos
- Speed up page load by loading sqlite data later like in @healeycodes/steve_web
- Store more (legally storable) analytics data, and maybe make a sparkline!
- Add some sort of way to contact me
- Move over all my blog posts from Github Pages (maybe into @std/blob as a CMS?)
Sparse autoencoder feature of the day email
This Val sends a daily notification email at the start of every day with a random high confidence (> 0.8) feature drawn from my sparse autoencoders project that tries to find interpretable directions in the latent space of embedding models.
It sends you an email with a brief description of the feature and a link to view more.
Here's an example email from this Val:
Every time you run it, you'll get a different feature. By default, this uses the lg-v6
model, which I think is a good one to start with, but this may change in the future as I train better feature dictionaries!
Sparse autoencoder feature of the day email
This Val sends a daily notification email at the start of every day with a random high confidence (> 0.8) feature drawn from my sparse autoencoders project that tries to find interpretable directions in the latent space of embedding models.
It sends you an email with a brief description of the feature and a link to view more.
Here's an example email from this Val:
Every time you run it, you'll get a different feature. By default, this uses the lg-v3-x1
model, which I think is a good one to start with, but this may change in the future as I train better feature dictionaries!
Twitter 𝕏 keyword Alerts
Custom notifications for when you, your company, or anything you care about is mentioned on Twitter.
1. Authentication
You'll need a Twitter Bearer Token. Follow these instructions to get one.
Unfortunately it costs $100 / month to have a Basic Twitter Developer account. If you subscribe to Val Town Pro, I can let you "borrow" my token. Just comment on this val and I'll hook you up.
2. Query
Change the query
variable for what you want to get notified for.
You can use Twitter's search operators to customize your query, for some collection of keywords, filtering out others, and much more!
3. Notification
Below I'm sending these mentions to a private channel in our company Discord, but you can customize that to whatever you want, @std/email, Slack, Telegram, whatever.
stevekrouse.com - my personal website
This val hosts my personal website. The view data is stored in Val Town SQLite - @std/sqlite.
It used to live on Github Pages, which is why I proxy over requests to certain blog posts over to the Github Pages site still.
Todos
- Speed up page load by loading sqlite data later like in @healeycodes/steve_web
- Store more (legally storable) analytics data, and maybe make a sparkline!
- Add some sort of way to contact me
- Move over all my blog posts from Github Pages (maybe into @std/blob as a CMS?)
Add an email entry option to your static website/blog. Easy peasy. 🚀
PoV: You just hacked together a portfolio website or launched a blog as a static website. Some people who visit might be interested in hearing more from you. ❤️ But you don't want to get lost building your backend, API, DB or fancy apps like SubstandardStack or MailMachineGun for people to sign up to your newsletter. 😩
All you want is a simple input box on your website - when someone types their email
, username
or social link
in and submits it, you want to be notified.
psst...do you want another one that uses the DB instead of email so you can look up all entries at once? Let me know and I'll get cooking!
Quickstart
Call the val URL with data in the query param userContact
. That's it!
// Format
`https://<val_url>?userContact=<mandatory_primary_contact>`
// Examples
`https://dvsj-subscribeToNewsletter.web.val.run?userContact=dav.is@zohomail.in`
`https://dvsj-subscribeToNewsletter.web.val.run?userContact=CatalanCabbage`
Bonus
Have extra data apart from email?
Pass any encoded data in the queryParam userData
, will be included in the email. It's optional.
// Format
`https://<val_url>?userContact=<mandatory_primary_contact>&userData=<optional_any_data>`
//Examples
`https://dvsj-subscribeToNewsletter.web.val.run?userContact=dav.is@zohomail.in&userData={"time": "2/2/1969", "twitter": "https://twitter.com/dvsj_in"}`
// Note: All values should be URL encoded. Example:
let userData = {"time": "2/2/1969", "twitter": "https://twitter.com/dvsj_in"}
let encodedUserData = encodeURIComponent(userData) //This should go in the query param
Want bot protection?
Add a simple question to your website, like "okay, so what's one minus one?"
.
In the val, set isBotProtectionOn = true
and botProtectionAnswer="0"
.
When you call the val, include the encoded user's answer to the bot question as botProtection
query param.
Answer will be compared with botProtectionAnswer
; if the answer is wrong, the request is rejected.
// Format
`https://<val_url>?userContact=<mandatory_primary_contact>&userData=<optional_any_data>&botProtection=<answer>`
//Examples
`https://dvsj-subscribeToNewsletter.web.val.run?userContact=dav.is@zohomail.in&botProtection=123`
Add it to your website
Want to add it to your site but get a headstart coding it? Use this ChatGPT prompt to get code for your website!
I'm building a simple form submission component. It should a submit button and these 2 input boxes:
1. "userContact" to get the user's email (mandatory)
2. "userData" to get a custom message from the user (optional)
On clicking the submit button:
1. Both input values should be encoded using "encodeURIComponent"
2. A GET URL should be built in this format with query params. Include userData query param only if input is not null or empty.
`https://dvsj-subscribeToNewsletter.web.val.run?userContact=<encodedUserContact>&userData=<encodedUserData>`
3. The GET URL should be called and result printed in the console.
I'm using React, so make it a react component.
You know how when you paste a URL in Twitter
or Slack
it shows you a nice preview? This val gives you that data.
Given a URL, this will return metadata about the website like title
, description
, imageURL
, image as base64
etc.
Sample input - paste this in your URL bar
https://dvsj-GetWebsiteMetadata.web.val.run?targetURL=https://dvsj.in https://dvsj-GetWebsiteMetadata.web.val.run?targetURL=<your-target-url-here>
Sample output:
{
status: 200,
url: "https://dvsj.in",
title: "Dav-is-here ➜",
description: "Davis' not-so-secret stash",
imgUrl: "https://www.dvsj.in/cover-picture.png",
imgData: "data:image/png;base64,qwertyblahblah"
}
FAQ:
Why is imgData
sent when imgUrl
is already present?
Because you shouldn't hotlink images from 3rd parties. Store the base64 image on your server and use it in your app.
It's unfair to use their server bandwidth and could be a security issue for you if they change the content of the link later.