Set a price alarm
set_price_alarmSets an alarm that rings on the person's phone when a token reaches a target price, or moves a percent from its price now. For one token's price; a trader or wallet trading, or anyone trading a token, is a different alarm. Takes the token's id, symbol and name, and exactly one of target_price_usd or percent. It rings once and then stops for good. Returns the alarm, the price it started from and its link.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The token's name, "Solana". | |
| note | No | A note from the person about the alarm, in their words, shown under its trigger on the alarm's page and in the Daily drop. Up to 500 characters; an empty note clears it. | |
| vibe | No | The feel of the alarm in a few words, and the kind of background and colour if the person named them: "fun poppy anime", "calm", "a simple bell", "hype for a token launch", "ocean waves, purple", "neon and chaotic". LFG picks a sound and a look from its library to match: a live, moving wallpaper when one fits, otherwise a drawn one. Wallpaper words given here replace the look's words; a colour given here makes it a plain gradient in that colour. | |
| brief | No | A brief on a schedule as well as the alarm: Rocco gathers on the topic through the day, and the brief arrives quietly at this time, as a notification and in the Daily Drop, never a ring. The phone still rings only when the alarm's own rule matches. Makes it a monitoring alarm. For a clock alarm whose ring brings the brief, use set_time_alarm with follow instead. | |
| chain | No | The token's chain, "solana", "base", "ethereum". | |
| reach | No | Who can join: private (only the person), friends (people on its list, or with its link), public (anyone; listed in Discover). | private |
| theme | No | A theme or holiday: the alarm gets a song in its moods, a new alarm a title written for it, and a wallpaper dealt for it for variety, one of the theme's pictures, a GIF, a live wallpaper or a gradient. A vibe given as well shapes that ("cozy", "degen"); wallpaper words or a title given are kept. One of: birthday (Birthday), love (Love), night_out (Night out), shopping (Shopping), winter (Winter), christmas (Christmas), hanukkah (Hanukkah), diwali (Diwali), halloween (Halloween), thanksgiving (Thanksgiving), friendsgiving (Friendsgiving), new_years (New Year's Eve). | |
| title | No | Short name for the alarm. When absent, LFG names it. Up to 60 characters; it reads best under about 25. | |
| symbol | Yes | The token's ticker, "SOL". | |
| percent | No | Rings when the price moves this much from now: 25 for up 25%, -10 for down 10%. | |
| surprise | No | For a friends alarm: keep it a surprise. People who join see a curtain instead of its title, picture, sound and note until it rings. Free on every plan. | |
| token_id | Yes | The token's id. | |
| link_mode | No | For a friends alarm, what its link does: open (anyone who opens the link rides along, the default) or approve (anyone else with the link asks first and the person says yes or no). Invited people walk straight in either way. | |
| add_groups | No | For a friends alarm: names of the person's friend groups whose members to let in, "Family". Members get a notification. | |
| add_people | No | For a friends alarm: up to 20 people to let in, as usernames of the person's LFG friends or as email addresses. Friends get a notification; an email address with no LFG account gets an invitation. Any other username is refused. | |
| button_link | No | ||
| words_color | No | Colour of the words as hex, any colour, "#D7FF00". | |
| hide_trigger | No | Needed with surprise, true or false: whether to also keep back when and why it rings, so people who join only know that it will. A surprise is not made until it is given. | |
| snooze_times | No | How many times it can be snoozed: 3, 10 or unlimited. | |
| silent_snooze | No | true to snooze without the spoken roast LFG plays by default. | |
| snooze_minutes | No | Minutes each snooze lasts: 5, 10, 15, 30 or 60. | |
| send_beacons_to | No | A webhook the person got from the other side (a Discord channel's hook, a Zapier catch hook, their own agent's address): every beacon on this alarm is POSTed there as JSON, signed with the alarm's horn token. Public https only. An empty string stops it. | |
| wallpaper_color | No | Wallpaper background colour as hex, any colour, "#5B2BFF". | |
| wallpaper_words | No | Words drawn on the wallpaper, "WAKE UP"; a line break starts a new line. Up to 40 characters; it looks best as 1 to 4 short words, since the words are drawn as large as the square allows. | |
| contract_address | No | The token's contract address, when it has one. | |
| people_confirmed | No | Whether the person has confirmed the people and groups being added. Nobody is added or told without it. | |
| target_price_usd | No | Rings when the price reaches this, in US dollars, from either side. |