PRpropcode
Unlocks and reports

Read a citation

The text a Rapid Planning Report citation points to, from the version the report read: GET its contentUrl. It answers with the cited passage, its text stopping at 10,000 characters (truncated says so). With includeParentSection=true it answers with the section the passage is in instead, with all its subclauses and the passage in <mark>, as the Library shows a citation; parentSection says which you got, since it's the passage alone where the section would be the whole document, runs past 20,000 characters, or is the passage itself. Each comes as HTML and as plain text. A report cites 50 to 100 passages, so read the ones you need. Any key reads them; a live key's team reads up to 2,000 different passages a day, and repeats are free. Legislation's text is the published legislation's; a development control plan's is read from the council's PDF, which libraryUrl opens.

get/v1/citations/{jurisdiction}/{document}/{version}/{file}/{passageId}

Request

  • Base URL
    https://app.propcode.com.au/api
  • Auth
    HTTP bearer

Path parameters

jurisdictionstring required

The state the document is in: nsw, vic, act or tas.

documentstring required

The document's id in PropCode's Library.

versionstring required

The document's version the report read, e.g. 2026-07-01.

fileinteger required

The document's file: 0 for most legislation; a DCP has several.

passageIdinteger required

The cited passage's id within the file, as a citation's contentUrl gives it: PropCode's own, not a clause number.

Query parameters

includeParentSectionboolean

true: the section the passage is in, with all its subclauses and the passage in <mark>, as the Library shows a citation, in place of the passage alone. parentSection says which you got: it's the passage alone where the section would be the whole document, runs past 20,000 characters, or is the passage itself.

Response

The cited text.

object'citation' required
versionstring required

The document's version, e.g. 2026-07-01.

fileinteger required

The document's file, by number, as the path names it.

passageIdinteger required

The passage, as the path names it (a text within an element reads as the element).

locationstring

Where the passage is in the document, by its headings, e.g. Part 4 › 4.3 Height of buildings.

fileNamestring

For a document published as PDFs, the name of the PDF the passage is in. Left out for legislation.

pageinteger

The page of that PDF the passage starts on, counting from 1, where the document records it.

pdfUrlstring

PropCode's copy of the council's PDF, opened at the page (#page=…). It stops working if PropCode removes that copy.

parentSectionboolean required

true: html and text are the passage's parent section, the passage in <mark>. false: they're the passage alone.

htmlstring required

The text as HTML.

textstring required

The same, plain: a line for each paragraph, list item or table row, with its number, e.g. (a).

truncatedunknown
libraryUrlstring required

The passage in PropCode's Library, at this version.

Changes

No recorded changes to this operation across all 1 revision of this API.