GET
/
v1
/
transparency
/
{id}
/
download
Download Token Transparency Report
curl --request GET \
  --url https://api.blockworks.com/v1/transparency/{id}/download \
  --header 'x-api-key: <api-key>'
This response does not have an example.

​
Overview

Download the complete token transparency framework report as a PDF file. This endpoint returns the full transparency report document that contains detailed analysis, scores, and supporting documentation for the specified project.

​
Example Request

curl -H "x-api-key: YOUR_API_KEY" \
  -o "transparency-report.pdf" \
  "https://api.blockworks.com/v1/transparency/1/download"

​
Response Format

This endpoint returns binary data with the following characteristics:
PropertyValue
Content-Typeapplication/pdf
Content-Dispositionattachment; filename="project-name-transparency-report.pdf"
Response BodyBinary PDF data

​
Supported Options

NameTypeDetails
idpathThe ID of the transparency report to download

​
Usage Notes

  • File Handling: The response contains binary PDF data that should be saved directly to a file or handled as a blob
  • Filename: Extract filename from Content-Disposition header or use a default name
  • Browser Usage: Use blob() method and URL.createObjectURL() for browser downloads
  • Server Usage: Write binary content directly to filesystem

​
Report Contents

The downloaded PDF contains:
  • Executive Summary: Overview of transparency score and key findings
  • Detailed Scoring: Breakdown of all four categories with explanations
  • Project Analysis: In-depth review of team, tokenomics, and governance
  • Supporting Documentation: Links and references to source materials
  • Methodology: Explanation of scoring criteria and framework

​
See also

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Response

PDF file download

The response is of type file.