Endpoint reference

GET /api/v1/indexer/{entity}/record

Parameters

NameLocationDetails
X-Juicebox-Accountheader / requiredEnrolled account identity, including authority chain and lowercase owner address. Enrollment derives this identity before the account exists.
X-Juicebox-Signerheader / requiredOwner wallet or authorized bot address that signed this request.
X-Juicebox-Issued-Atheader / requiredUnix seconds, sent as 1–13 decimal digits without leading zeros; at most 30 seconds ahead of server time.
X-Juicebox-Expires-Atheader / requiredUnix seconds, sent as 1–13 decimal digits without leading zeros; in the future and within 300 seconds of issuedAt.
X-Juicebox-Nonceheader / requiredFresh random 32-byte lowercase nonce. A consumed nonce cannot be retried.
X-Juicebox-Signatureheader / requiredEIP-712 CenterRequest signature over every signed field. Contract-owner signatures may vary in length. This is a computed request proof, not a reusable API key.
X-Juicebox-Grantheader / optionalAuthorized bot grant ID. Required for a bot; omit for the owner, signing grantId as the empty string.
Idempotency-Keyheader / optionalSigned retry identity. Required on plan creation and transaction submission. Preserve exact method, target, Content-Type, and body bytes; use a fresh request nonce and signature.
entitypath / requiredstring

["_sucker","accountingSyncEvent","activityEvent","addNftTierEvent","addToBalanceEvent","autoIssueEvent","borrowLoanEvent","bridgeClaimEvent","bridgeToOutboxEvent","bridgeToRemoteEvent","burnEvent","buybackPool","buybackPoolEvent","buybackPoolLiquidityEvent","buybackPoolPosition","buybackPoolRange","cashOutTaxSnapshot","cashOutTokensEvent","decorateBannyEvent","deployErc20Event","inboxRootReceivedEvent","liquidateLoanEvent","loan","manualBurnEvent","manualMintTokensEvent","mintNftEvent","mintTokensEvent","nft","nftHook","nftTier","operatorPermissionsSetEvent","participant","participantSnapshot","payEvent","permissionHolder","project","projectCreateEvent","projectMoment","projectPayer","projectTransferEvent","reallocateLoanEvent","removeNftTierEvent","repayLoanEvent","rulesetQueuedEvent","sendPayoutToSplitEvent","sendPayoutsEvent","sendReservedTokensToSplitEvent","sendReservedTokensToSplitsEvent","setUriEvent","storeAutoIssuanceAmountEvent","suckerGroup","suckerGroupMoment","suckerTransaction","swapEvent","useAllowanceEvent","_meta"]

networkquery / requiredstring

["mainnet","testnet"]

chainIdquery / optionalMust belong to the chosen indexer network.

[1,10,8453,42161,84532,421614,11155111,11155420]

projectIdquery / optionalExact nonnegative decimal string no greater than 9007199254740991.
idquery / optionalExact key names are in the entity's singleArgs catalog entry; version is fixed to 6. Serialize as JSON once, percent-encode the query value, then sign the exact resulting request target.
fieldsquery / optionalBounded scalar field paths or supported singular relations. Identity fields are always included. Serialize as JSON once, percent-encode the query value, then sign the exact resulting request target.

Response 200

FieldTypeDetails
entitystring
required
networkstring
required

Values: ["mainnet","testnet"]

protocolVersioninteger
required

Values: [6]

itemone of
required
provenanceobject
required
semanticsobject
required
Bendystraw indexing is not a canonical block-hash snapshot. Preserve lag, pagination, scope, and unknown-field semantics.
JSON schema
{
  "type": "object",
  "properties": {
    "entity": {
      "type": "string"
    },
    "network": {
      "type": "string",
      "enum": [
        "mainnet",
        "testnet"
      ]
    },
    "protocolVersion": {
      "$ref": "#/components/schemas/ProtocolVersion"
    },
    "item": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    },
    "provenance": {
      "type": "object",
      "additionalProperties": true
    },
    "semantics": {
      "$ref": "#/components/schemas/IndexerSemantics"
    }
  },
  "required": [
    "entity",
    "network",
    "protocolVersion",
    "item",
    "provenance",
    "semantics"
  ],
  "additionalProperties": false
}