Returns outputs filtered based on parameters.

GET 
/api/indexer/v1/outputs

Returns outputs filtered based on parameters.

Request

Query Parameters

unlockableByAddress string
The Bech32-encoded address that should be searched for in all possible Unlock Conditions of outputs.
Example: iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx
hasNativeTokens boolean
Filters outputs based on the presence of native tokens.
Example: true
minNativeTokenCount integer
Filters outputs that have at least a certain number of distinct native tokens.
Example: 2
maxNativeTokenCount integer
Filters outputs that have at most a certain number of distinct native tokens.
Example: 5
createdBefore integer
Return outputs that were created before a certain Unix timestamp.
Example: 1643383242
createdAfter integer
Return outputs that were created after a certain Unix timestamp.
Example: 1643383242
pageSize integer
The maximum amount of items returned in one call. If there are more items, a cursor to the next page is returned too. The parameter is ignored when pageSize is defined via the cursor parameter.
Example: 10
cursor string
Starts the search from the cursor (confirmationMS+outputId.pageSize).
Example: 0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790200.10

Responses

200

Successful operation.

application/json

Schema

Schema

ledgerIndex integerrequired

The current ledger index for which the request was made.

cursor stringnullable

The cursor to use for getting the next page of results.

items string[]required

The output IDs (transaction hash + output index) of the outputs satisfying the query. Hex-encoded with 0x prefix.

Example (from schema)

{
  "ledgerIndex": 0,
  "cursor": "string",
  "items": [
    "string"
  ]
}

Query results in 3 outputs

{
  "ledgerIndex": 101,
  "items": [
    "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790000",
    "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790100",
    "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790200"
  ]
}

No matching outputIds found

{
  "ledgerIndex": 101,
  "items": [
    null
  ]
}

Paging - more items found than it can fit on single page

{
  "ledgerIndex": 101,
  "cursor": "61fa44a14d35ce14b9d0e7ee6ac9af70c0af156be269f69348be6d6f83c80a3a8a44ce440000.2",
  "items": [
    "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790000",
    "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790100"
  ]
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...