Skip to main content
POST
/
api
/
v1
/
muni_documents
Get documents for a municipal bond
curl --request POST \
  --url https://terrapinfinance.com/api/v1/muni_documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type": "official_statement",
  "isin": "US002842EZ11"
}
'
{
  "data": [
    {
      "document_name": "Official Statement posted 08/15/2023 (1.6 MB)",
      "document_type": "official_statement",
      "file_id": "ROaomzq-lhfQ-LMSd8Zvow.pdf",
      "filing_type": null,
      "isin": "US002842EZ11",
      "publish_date": "2023-08-15",
      "text_file_id": "ROaomzq-lhfQ-LMSd8Zvow.txt"
    }
  ],
  "total": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
document_type
enum<string>
required

Type of document to retrieve. official_statement returns the official statements for the specific bond. disclosure_document returns disclosure documents for the bond's obligor.

Available options:
disclosure_document,
official_statement
​
isin
string
required

International Securities Identification Number (ISIN), unique 12-character code for the security.

Required string length: 12

Response

File IDs and metadata for documents associated with the municipal bond

​
data
object[]
required

List of response data objects, often capped to 1000.

​
total
integer
required

Total number of results in the database that match the query filters.