URL Schemes

The Sablier Interface makes it easy for integrators to direct their users to specific resources. In this guide, we will cover a number of resource locators used by the apps, as well as dive into how you can understand and re-create them.

Stream Page

Elements

Every stream created through the Sablier Protocol is identified through three parameters:

• a chainId (e.g. 1 for Ethereum, 10 for Optimism )
• a contract address (e.g. 0x12..AB) OR an alias (e.g. LL)
• a streamId (generated at stream creation)

Contract Aliases

Sablier V2 supports multiple versions and variants of streaming contracts, e.g. SablierV2LockupLinear and SablierV2LockupDynamic. Specifically, their core-1.0.0. To provide a simple visual structure, while also accounting for future stream types (backwards compatibility), we use the following abbreviations as aliases:

• Lockup Linear contracts become LL, e.g. LL-5-1
• Lockup Dynamic contracts become LD, e.g. LD-5-1

Building the URL

By combining the elements described above, you can send users from your interface directly to the stream page featured in the Sablier Interface. To build the link to a stream resource, you use a hyphen - to concatenate the uppercase contract alias, the chainId, and the streamId, and then you add them to the base link app.sablier.com/stream/:

URL	Description
app.sablier.com/stream/LL-5-40	Lockup Linear (v1.0.0) stream #40 on Goerli
app.sablier.com/stream/LL-1-6	Lockup Linear (v1.0.0) stream #6 on Ethereum
app.sablier.com/stream/0xB10...f95-1-6	Lockup Linear (v1.0.0) stream #6 on Ethereum
app.sablier.com/stream/LD-137-13	Lockup Dynamic (v1.0.0) stream #13 on Polygon

As you can see, the main format is contractA-chainId-streamId. This is supported both at the app and the subgraph level. For situations when an alias cannot be used, we fallback to the following format: contractAddress-chainId-streamId. Read more about identifiers and aliases in our subgraph documentation.

---

Create Stream Autofill

Elements

Using URL query parameters, integrators can suggest a set of values for the fields of the Create Single Stream form. Here's a list of all supported values (to be appended to the create form link):

Parameter	Type	Description	Example
shape	String	Type of payment	linear, cliff, dynamicExponential, dynamicExponentialCliff, dynamicStepper
chainId	Number	Defaults to the connected chain	1, 10, 42161 or any other supported chain
token	String	Address of the asset	0x6b17...1d0f (DAI)
cancelable	Boolean	If a stream is cancelable or not, defaults to true	true, false
recipient	String	Recipient's address or ENS	0x12...AB, vitalik.eth
isDuration	Boolean	If the time is set to a duration or a fixed range, defaults to true	true, false
duration	Number	Stream duration in seconds, read only if isDuration is true	86400 (1 day)
start	Number	Start date in seconds, read only if isDuration is false	1692009403
end	Number	End date in seconds, read only if isDuration is false	1702000403
cliff	Number	Cliff duration or the cliff end date as a Unix timestamp in seconds (depends on isDuration and shape)	1296000 (12 hours)
steps	Number	Number of steps for the dynamicStepper shape.	2, 3, 4, etc.

info

Make sure the token is available on the selected chain. To make the token appear in the default list, you can submit a request to add it to the Sablier Community Token List.

Building the URL

By combining the parameters described above, you can send users from your interface directly to the stream creation page in the Sablier Interface. To build the link to a stream resource, you append all these elements to the base link app.sablier.com/create/single as query parameters (?key1=value1&key2=value2).

Here are some examples:

URL	Description
app.sablier.com/create/single/?shape=linear&chainId=1&duration=86400	A partially configured stream (chain, duration)
app.sablier.com/create/single/?shape=linear&chainId=1&duration=86400&token=0x...	A partially configured stream (chain, duration, token = DAI)
app.sablier.com/create/single/?shape=cliff&...&isDuration=false	A fully configured stream

If everything is set up correctly, a modal will show up with a summary of the stream.

Modal	Form after "Fill in"

If some parameters are not configured properly, the modal will give some indications to the user:

Search Streams

Elements

The Sablier Interface comes with an advanced search view that can be accessed directly through URL parameters. If you want to use this feature, here is a table with all the available parameters:

Parameter	Type	Description	Values
t	String	The active tab in the dashboard. For global queries, use search.	search, sender, or recipient
c	Number	The chain of the streams in the search result. This parameter is required.	1, 10, 42161 or any other supported chain
s	String	The address of the stream sender by which to filter	0x12...AB, vitalik.eth
r	String	The address of the stream recipient by which to filter	0x12...AB, vitalik.eth
i	String array	An array of stream identifiers to look up	LL-5-1, LD-5-14 etc.

Building the URL

By combining the parameters described above, you can send users from your interface directly to the search view in the Sablier Interface. To build the link, you append all these elements to the base link app.sablier.com/ as query parameters, e.g. ?t=search&c=1&s=0x..1&r=0x...2&i=LL-1-1,LL-5-2.

Here are some examples of URLs and the associated search modal for each:

All streams from goerli that involve am address
Streams that have address as sender from list