Relayer API
GET /see/:ref
How to look up a Geode upload by its Irys id or its pay signature and read what is public about it and what stays sealed.
GET /see/:ref answers what anyone can learn about a Geode upload from a public reference: the Irys id in a share link, or the signature of its pay transaction. It returns the receipt's public fields beside the list of what stays sealed. The site's /see page is built on it. See Public fields.
Request
GET /see/<Irys id or pay signature>Path
refrequiredIrysId | SignatureEither an Irys id (43 characters of
[A-Za-z0-9_-]) or a pay transaction signature (base58 of 64 bytes, 64 to 88 characters).Response
SeeResponse
kindrequired'geode'Always
geode: the reference is a Geode upload.sealedrequiredstring[]What the reference does not reveal, as labels to show.
sealed lists:
- File bytes
- File name
- File type
- Exact file size
- File key
- Spending key
- Wallet-to-payment link
Behaviour
An Irys id matches the receipt stored under it. A signature matches the receipt whose pay transaction it signs, so a receipt is found by signature from the moment it is paid and by Irys id once it is stored.
The checks run in this order:
- The relayer is ready (
PROGRAM_UNAVAILABLE). refis an Irys id or a signature (VALIDATION_ERROR).- An indexed receipt with this Irys id or
paysignature: it is returned. - An Irys id: the relayer looks it up on Irys (
IRYS_UNAVAILABLEwhen that fails). Unknown there, it answersNOT_FOUND; known,NOT_GEODE, since no indexed Geode receipt holds it. - A signature: the relayer reads the transaction from Solana. Unknown there, it answers
NOT_FOUND. Otherwise it indexes new program transactions and returns the receipt that signature paid, or answersNOT_GEODEwhen the transaction holds no Geode storage payment.
Errors
Codes are explained in full under Errors.
| Code | Raised when | Next |
|---|---|---|
PROGRAM_UNAVAILABLE | The relayer is not ready. Retryable. | Retry later. |
VALIDATION_ERROR | ref is neither an Irys id nor a signature. | Paste the id from the share link (the part before #) or the transaction signature. |
NOT_GEODE | The Irys id is not an indexed Geode upload ("This Irys id is not an indexed Geode upload."), or the transaction holds no Geode storage payment ("This transaction does not contain a Geode storage payment."). | Show that the reference belongs to something else. |
NOT_FOUND | Irys has no item with this id ("This Irys id was not found."), or Solana has no transaction with this signature ("This Solana signature was not found."). | Check the reference. |
IRYS_UNAVAILABLE | The Irys lookup failed. Retryable. | Retry later. |
Example
GET /see/bSAbr3nZWiTjjriWwg2eLRrxMwxlH4qJZy2TuMRr82c
Accept: application/json
const { receipt, sealed } = await client.see(ref)