Skip to content
Sign in Sign up

A bought report

GETapi.baseray.ai/v1/public/building-reports/{token}

The report a token opens. While its Checkout is open the report is first settled from Stripe's current state, so it reads paid as soon as Stripe has the payment. A paid report opens its building for 12 months from payment (accessUntil). Limited per report: 240 reads a minute with one token, its building's reads included.

Path parameters

tokenstringrequired
The report's token: 43 base64url characters, from the report's link (https://app.baseray.tech/report/{token}).

Response 200

OK

statuspending | paid | expiredrequired
pending while Checkout is open, paid, or expired when Checkout closed unpaid.
buildingobjectrequired
idstring (uuid)required
countrystringrequired
Lower case, as the public pages give it (cz).
titlestringrequired
The building's address as its public page writes it.
localeen | ro | cs | darequired
The language it was bought in.
paidAtstring (date-time) or nullrequired
accessUntilstring (date-time) or nullrequired
Until when the report opens its building: 12 months from payment.

Errors

404
No report has this token (not_found).
429
Too many reads with this report's token in a minute (rate_limited); retry after Retry-After seconds.

Every error has the same shape. Error codes.