Skip to content

Comparable Detail PDF

GET /comparable/::uuid/pdfbase64

Generates a PDF containing comparable detail data. The default output is a PDF in base64 format to allow easy integration wherever needed; alternatively, by adding the file query string parameter, it is possible to directly download the PDF file.

Example Request (pdfbase64)

curl -X GET --location 'https://sandbox-comparables.realitycs.it/comparable/37547303-a542-4a14-87db-1892223d769a/pdfbase64?force' \
--header 'Authorization: Bearer <token>'

Example Response (pdfbase64)

{
    "base64_data": "JVBERi0xLjQKJdPr6eEKMSA
                    ...
                    ...
                    CnN0YXJ0eHJlZgoxNDQxNTAKJSVFT0YK",
    "content_type": "application/pdf",
    "filename": "37547303-a542-4a14-87db-1892223d769a.pdf"
}

Example Request (pdf)

curl -X GET --location 'https://sandbox-comparables.realitycs.it/comparable/37547303-a542-4a14-87db-1892223d769a/pdfbase64?file&force' \
--header 'Authorization: Bearer <token>'

Example Response (pdf)

Request args

arg type Notes
uuid str mandatory in the input: *

Query string parameters

arg Notes Description
file Empty parameter which is optional in the input Returns a pdf file with the details of the comparable
force Empty parameter which is optional in the input Forces the application to recreate the PDF even if it already exists in the system