Get Live Banner
curl --request GET \
--url https://api.example.com/bannerimport requests
url = "https://api.example.com/banner"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/banner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/banner",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/banner"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/banner")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/banner")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"headline": "<string>",
"body": "<string>",
"cta_label": "<string>",
"badge": "<string>",
"link_url": {},
"period_start / period_end": {},
"published_at": {},
"expires_at": {},
"commit_count": {}
}Banner
Get Live Banner
Get the announcement banner currently live for a project
GET
/
banner
Get Live Banner
curl --request GET \
--url https://api.example.com/bannerimport requests
url = "https://api.example.com/banner"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/banner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/banner",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/banner"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/banner")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/banner")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"headline": "<string>",
"body": "<string>",
"cta_label": "<string>",
"badge": "<string>",
"link_url": {},
"period_start / period_end": {},
"published_at": {},
"expires_at": {},
"commit_count": {}
}Returns the announcement banner currently live for a project — the one-line bar (badge, headline, one-sentence body, call-to-action) that the embed widget shows at the top of a site. Exactly one banner is live per project: publishing a new one replaces it.
With an API token the response is your project’s banner. Without a token it is Shipstar’s own (what shipstar.ai renders above its nav). A
404 means no banner is live — never published, replaced, or past its take-down time — and is the normal empty state, not an error: render nothing.
Send X-Shipstar-Page-Url with the page you render it on so your dashboard’s “Published” status links there.
Request
curl -X GET "https://api.shipstar.ai/api/v1/banner" \
-H "Authorization: Bearer $SHIPSTAR_API_TOKEN" \
-H "X-Shipstar-Page-Url: https://your-site.com/"
const response = await fetch('https://api.shipstar.ai/api/v1/banner', {
headers: {
Authorization: `Bearer ${process.env.SHIPSTAR_API_TOKEN}`,
'X-Shipstar-Page-Url': 'https://your-site.com/',
},
next: { revalidate: 300 },
});
const banner = response.status === 404 ? null : await response.json();
import os, requests
response = requests.get(
'https://api.shipstar.ai/api/v1/banner',
headers={
'Authorization': f"Bearer {os.environ['SHIPSTAR_API_TOKEN']}",
'X-Shipstar-Page-Url': 'https://your-site.com/',
},
)
banner = None if response.status_code == 404 else response.json()
Response
string
The stable embed key (
data-shipstar-key). It does not change when a new banner replaces the old one.string
At most 80 characters.
string
One sentence on the benefit, at most 160 characters. The widget hides it on narrow screens.
string
Call-to-action label, at most 24 characters.
string
Short tag to show before the headline, at most 16 characters —
"New" unless the banner re-worded it. An empty string means the banner has no badge: render nothing.string | null
Where the call-to-action points.
null means the banner has no link — omit the button.string | null
The commit window the banner was generated from (
YYYY-MM-DD).string | null
ISO-8601. Changes with every publish; use it as a cache key or a “seen” marker.
string | null
When the banner stops being served, if a take-down was set on the schedule. The API already stops serving it then; respect it if you cache longer.
integer | null
Provenance: how many commits the banner was generated from.
Example Response
200
{
"slug": "acme-banner",
"headline": "Scheduled X threads now post themselves",
"body": "Approve once; Shipstar posts the thread at the scheduled time.",
"cta_label": "See what's new",
"badge": "New",
"link_url": "https://acme.com/changelog",
"period_start": "2026-08-31",
"period_end": "2026-09-07",
"published_at": "2026-09-07T09:02:11+00:00",
"expires_at": null,
"commit_count": 14
}
Errors
| Status | Description |
|---|---|
| 404 | No banner is live for the project |
| 429 | Rate limit exceeded — wait Retry-After seconds |
Was this page helpful?