Skip to content

Report PDF download

GET /api/report/appraisal/<report_uuid>/download

Downloads the report as a PDF, already laid out with the Immobiliare.it Insights template. Use it when you want to hand over the finished document instead of rendering the blocks yourself.

Example Request

curl --location 'https://insights.immobiliare.it/api/report/appraisal/95318f91-dbc4-4a20-ae71-e511ef6282cf/download' \
--header 'Authorization: Bearer <token>' \
--output report.pdf

Request Fields

Field Required Default Description Type Example Notes
report_uuid yes UUID of the report, returned by the creation string 95318f91-dbc4-4a20-ae71-e511ef6282cf Path parameter

Response

Unlike every other endpoint of this section, this one does not answer with the JSON envelope: on success the body is the PDF file itself.

Header Value
Content-Type application/pdf
Content-Disposition attachment; filename=report_immobiliare_<id>.pdf
Content-Length Size of the document, in bytes

Suggested filename

The <id> in Content-Disposition is an internal progressive identifier of the document, not the report_uuid. Read the filename from the header if you want to keep the one suggested by the service, otherwise name the file yourself, for instance after the reference you passed at creation time.

Size and generation time

The document is rendered on demand, so the call is noticeably slower than the data blocks and the payload is large: expect a few seconds and a few megabytes. Stream the response to disk rather than buffering it in memory, and do not call this endpoint to check whether a report is ready, use Report status for that.

Errors

Errors are returned with the standard JSON envelope, so branch on the response Content-Type rather than assuming a PDF body.

Status Description
200 The body is the PDF document
400 Unknown report_uuid
403 Missing, invalid or expired access token

See also the general Error Handling page.