Olly APIserver.olly.bot ↗
Resolve Olly referral invite pages into their SMS link, phone number, prefilled message, and full href details via a single API endpoint.
What is the Olly API?
The server.olly.bot API exposes one endpoint, get_text_olly_link, that returns 8 structured fields from an Olly referral invite page — including the literal anchor href, the resolved absolute URL, the sms: URI, the E.164 recipient phone number, and the URL-decoded prefilled SMS message body. Pass a referral code and an optional source tag; get back everything needed to programmatically inspect or reconstruct a referral invite flow.
curl -X GET 'https://api.parse.bot/scraper/48afdd2e-60a9-4819-bfbf-7f7686cad71b/get_text_olly_link?referrer=KzE5Mjk0NTcyMzUx' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace server-olly-bot-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: resolve an Olly referral invite into its SMS link and phone number."""
from parse_apis.server_olly_bot_api import OllyBot, InputFormatInvalid
client = OllyBot()
# Look up the invite link for a known referral code.
try:
link = client.invite_links.get(referrer="KzE5Mjk0NTcyMzUx")
except InputFormatInvalid:
print("Invalid or missing referrer code")
raise
print(link.label) # e.g. "Text Olly 👋"
print(link.phone_number) # E.164 recipient number
print(link.sms_body) # prefilled SMS message, URL-decoded
print(link.cta_url) # absolute URL the button points to
# src defaults to "referral"; pass a different value or omit it entirely.
link_no_src = client.invite_links.get(referrer="KzE5Mjk0NTcyMzUx", src="")
print(link_no_src.src) # None when src was omitted from the link
print("exercised: invite_links.get")
Returns the 'Text Olly' link for a referral invite page (/chat/start) as the site serves it: the literal anchor href (a relative query string of the form ?referrer=<code>&go=1&h=<base64 of the phone number>&src=<src>), its absolute form, the sms: URL that link redirects to, the recipient phone number, and the URL-decoded prefilled SMS body. One round trip. The site assigns the recipient number per request from a small rotating pool (four distinct US numbers were observed for the same referral code), so repeated calls can return different phone numbers and hrefs while the message body stays the same; the sms_body always embeds the referral code. The invite page only renders the button markup for Apple-device browsers, so the href is assembled from the site's own redirect target rather than read from the page; its form was verified against the button as rendered in a browser. An unknown referral code is not rejected by the site; the sms: link is still produced with that code. A missing referrer returns a stale_input error.
| Param | Type | Description |
|---|---|---|
| src | string | Value of the invite URL's src query parameter, echoed into the href. Pass an empty string to omit src from the link entirely. |
| referrerrequired | string | Referral code exactly as it appears in the invite URL's referrer query parameter (an opaque base64-like token, e.g. one shape: KzE5Mjk0NTcyMzUx). |
{
"type": "object",
"fields": {
"src": "src value echoed from the input, null when omitted",
"href": "literal relative href of the Text Olly anchor (query string starting with ?)",
"label": "visible text of the call-to-action button",
"cta_url": "href resolved against the invite page into an absolute URL",
"referrer": "referral code echoed from the input",
"sms_body": "URL-decoded prefilled SMS message",
"sms_href": "the sms: URL the href redirects to, with the body still URL-encoded",
"phone_number": "recipient phone number in E.164 form, taken from sms_href"
},
"sample": {
"data": {
"src": "referral",
"href": "?referrer=KzE5Mjk0NTcyMzUx&go=1&h=KzE0MTUzMTYyODU0&src=referral",
"label": "Text Olly 👋",
"cta_url": "https://server.olly.bot/chat/start?referrer=KzE5Mjk0NTcyMzUx&go=1&h=KzE0MTUzMTYyODU0&src=referral",
"referrer": "KzE5Mjk0NTcyMzUx",
"sms_body": "👋 hey, my friend sent me! (ref:KzE5Mjk0NTcyMzUx)",
"sms_href": "sms:+1 (555) 012-3456&body=%F0%9F%91%8B%20hey%2C%20my%20friend%20sent%20me!%20(ref%3AKzE5Mjk0NTcyMzUx)",
"phone_number": "+1 (555) 012-3456"
},
"status": "success"
}
}About the Olly API
What the API Returns
The single get_text_olly_link endpoint accepts two inputs: referrer (required) — the opaque base64-like token that appears as the referrer query parameter in an Olly /chat/start invite URL — and src (optional) — the source tag echoed from the same invite URL. The response mirrors both inputs back alongside the resolved link data, so you can confirm the exact parameters used in each call.
Response Fields in Detail
The response contains href (the literal relative href of the "Text Olly" anchor, a query string beginning with ?), cta_url (that href resolved into a full absolute URL against the invite page), label (the visible button text), sms_href (the sms: URI the link resolves to, with the message body still URL-encoded), phone_number (the recipient number in E.164 format, extracted from sms_href), and sms_body (the URL-decoded prefilled message text). When src is omitted, its field returns null.
Practical Scope
This API is tightly scoped to the /chat/start referral invite page on server.olly.bot. It does not cover other Olly pages, user account data, or referral analytics — only the link structure and SMS details embedded in a single invite URL. The referrer parameter must match the code exactly as it appears in the invite URL; no normalization or lookup is performed.
The Olly API is a managed, monitored endpoint for server.olly.bot — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when server.olly.bot changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official server.olly.bot API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Extract the E.164 phone number from an Olly referral invite for CRM or contact deduplication.
- Decode the prefilled SMS message body from a referral link to audit or log referral messaging.
- Validate that a referral code resolves to the expected
sms:URI before distributing invite links. - Compare
srcvalues across multiple invite URLs to track referral source tagging consistency. - Reconstruct the absolute
cta_urlfrom a referral code for use in custom landing pages or redirects. - Programmatically verify that the visible button
labelmatches expected copy in an invite campaign.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 200 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
| Team | $300/mo | 20,000 | 300 req/min |
| Company | $1,000/mo | 100,000 | 500 req/min |
Each endpoint has a fixed posted price per successful call — most fall between 1 and 10 credits — shown on this API's page before you run it. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does Olly provide an official developer API?+
What exactly does `get_text_olly_link` return when `src` is omitted?+
src is not passed, the src field in the response is null and the href and cta_url fields will not include a src query parameter, matching how the invite page renders the link without that tag.Does the API return referral analytics, click counts, or conversion data?+
href, cta_url, label, sms_href, phone_number, sms_body, referrer, and src. Analytics and conversion data are not part of the response. You can fork the API on Parse and revise it to add an endpoint targeting any Olly page that exposes such data.Can the API look up multiple referral codes in a single call?+
referrer code. Batch lookup across multiple codes is not supported in the current endpoint. You can fork the API on Parse and revise it to add batch handling.What happens if an invalid or expired referral code is passed?+
sms_href and phone_number — may be absent or empty.