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

HTTP
GET /see/<Irys id or pay signature>
Path
refrequired
IrysId | Signature
Either 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.
receiptrequired
ReceiptResponse
The upload's receipt, field for field as GET /receipt/:id returns it.
sealedrequired
string[]
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:

  1. The relayer is ready (PROGRAM_UNAVAILABLE).
  2. ref is an Irys id or a signature (VALIDATION_ERROR).
  3. An indexed receipt with this Irys id or pay signature: it is returned.
  4. An Irys id: the relayer looks it up on Irys (IRYS_UNAVAILABLE when that fails). Unknown there, it answers NOT_FOUND; known, NOT_GEODE, since no indexed Geode receipt holds it.
  5. 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 answers NOT_GEODE when the transaction holds no Geode storage payment.

Errors

Codes are explained in full under Errors.

CodeRaised whenNext
PROGRAM_UNAVAILABLEThe relayer is not ready. Retryable.Retry later.
VALIDATION_ERRORref is neither an Irys id nor a signature.Paste the id from the share link (the part before #) or the transaction signature.
NOT_GEODEThe 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_FOUNDIrys 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_UNAVAILABLEThe Irys lookup failed. Retryable.Retry later.

Example

HTTP
GET /see/bSAbr3nZWiTjjriWwg2eLRrxMwxlH4qJZy2TuMRr82c
Accept: application/json