Get all outputs that use a given bech32-encoded address.

GET 
/api/v1/addresses/:address/outputs

Get all outputs that use a given bech32-encoded address. If count equals maxResults, then there might be more outputs available but those were skipped for performance reasons. User should sweep the address to reduce the amount of outputs.

Request

Path Parameters

address stringrequired
bech32-encoded address that is referenced by the outputs.
Example: iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx

Query Parameters

include-spent boolean
Set to true to also include the known spent outputs for the given address.
Example: true
type integer
Allows to filter the results by output type. Set to value 0 to filter outputs of type SigLockedSingleOutput. Set to value 1 to filter outputs of type SigLockedDustAllowanceOutput.
Example: 0

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired

addressType integerrequired

The type of the address. Value 0 denotes a Ed25519 address.

address stringrequired

The hex-encoded Ed25519 address.

maxResults integerrequired

The number of results it can return at most.

count integerrequired

The actual number of found results.

outputIds string[]required

The identifiers of the outputs that use a certain address.

ledgerIndex integerrequired

The current ledger index for which the request was made.

Example (from schema)

{
  "data": {
    "addressType": 0,
    "address": "string",
    "maxResults": 0,
    "count": 0,
    "outputIds": [
      "string"
    ],
    "ledgerIndex": 0
  }
}

default

{
  "data": {
    "addressType": 0,
    "address": "efdc112efe262b304bcf379b26c31bad029f616ee3ec4aa6345a366e4c9e43a3",
    "maxResults": 1000,
    "count": 4,
    "outputIds": [
      "1ee46e19f4219ee65afc10227d0ca22753f76ef32d1e922e5cbe3fbc9b5a52980100",
      "3d36ec4afb2d634b9313f84606b98b69675a3ef6f44dcdecb18c30945b57221e0100",
      "ee3447d088e3e2c53c5b3e56a38fdc859ca2c4b4161cf256c0462ce4d34731820100",
      "f8bdbfb0f57ade7fbb95d31b11e2dbda9b2a35e9dc0cd3e11cb324e8a6bedc260100"
    ],
    "ledgerIndex": 946704
  }
}

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"
  }
}

503

Unsuccessful operation: indicates that the node is not synced.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

Loading...