Pressburst API
The Pressburst API allows developers to retrieve published news stories and display them on external websites.
Using the API gives your website developer control over how stories are presented, including their layout, styling and integration with your existing website.
API overview
The Pressburst public news API uses JSON.
Base URL:
https://api.pressburst.app/v3
Two public news endpoints are available:
- News collection – retrieve multiple published news stories.
- News item – retrieve an individual published story.
API credentials
To use the API, you will need:
- API channel code – identifies the news channel.
- API key – authorises access to the API.
If you do not have these details, contact Pressburst support.
News collection
Retrieve published stories from a Pressburst news channel.
Endpoint
GET https://api.pressburst.app/v3/public/news/{channelCode}/?apikey={apiKey}
Replace:
{channelCode}with your API channel code.{apiKey}with your API key.
Response structure
The JSON response includes the following primary elements:
| Field | Description |
|---|---|
meta |
Information about the channel and returned records. |
newsitems |
Array containing the news stories. |
paging |
Pagination information, including next and previous pages where applicable. |
News item
Retrieve an individual news story using its URL-friendly headline.
Endpoint
GET https://api.pressburst.app/v3/public/news/{channelCode}/{sefheadline}/?apikey={apiKey}
Replace {sefheadline} with the story’s URL-friendly headline identifier.
News story fields
Each news story contains information that can be used to display the content on your website.
| Field | Description |
|---|---|
newsitemid |
Unique identifier for the news story. |
sourceid |
Identifier of the original story. |
organisation |
Name of the organisation that created the story. |
sefname |
URL-friendly organisation name. |
newsdate |
Date associated with the story. |
headline |
Story headline. |
sefheadline |
URL-friendly headline identifier. |
standfirst |
Story summary or introductory text. |
body |
Main story content. |
publishdate |
Publication date. |
publisher |
Publishing organisation. |
shortcode |
Unique alphanumeric story code. |
tags |
Array of tags assigned to the story. |
categories |
Array of URL-friendly category names. |
fullcategories |
Categories assigned to the story. |
channelid |
Unique identifier for the channel. |
channelname |
Channel name. |
channelsef |
URL-friendly channel name. |
media |
Array of associated media objects. |
Media fields
News stories can include associated media such as photographs, documents and embedded content.
| Field | Description |
|---|---|
mediaobjectid |
Unique media identifier. |
isprimary |
Indicates whether the image is the primary photograph. |
width |
Image width. |
height |
Image height. |
fileurl |
File URL. |
filesslurl |
HTTPS file URL. |
mime |
MIME type. |
type |
Media type. |
filename |
Filename or embedded media provider. |
fileext |
File extension. |
caption |
Media caption. |
credit |
Photograph credit or attribution. |
sizes |
Available resized image URLs and dimensions. |
embedcode |
Embed code for supported video or audio content. |
Displaying news on your website
Your website developer can use the API to:
- Retrieve your school’s published news stories.
- Display news headlines and summaries.
- Create individual story pages.
- Display associated photographs and media.
- Build custom news listings and layouts.
Technical support
If you need assistance with the API or would like to discuss a custom integration, contact Pressburst support.