Skip to content

Latest commit

 

History

History
177 lines (125 loc) · 7.06 KB

CardanoMetadataAPI.md

File metadata and controls

177 lines (125 loc) · 7.06 KB

CardanoMetadataAPI

All URIs are relative to https://cardano-mainnet.blockfrost.io/api/v0

Method HTTP request Description
getTransactionMetadataCborForLabel GET /metadata/txs/labels/{label}/cbor Transaction metadata content in CBOR
getTransactionMetadataJsonForLabel GET /metadata/txs/labels/{label} Transaction metadata content in JSON
getTransactionMetadataLabels GET /metadata/txs/labels Transaction metadata labels

getTransactionMetadataCborForLabel

    open class func getTransactionMetadataCborForLabel(label: String, count: Int? = nil, page: Int? = nil, order: SortOrder? = nil, completion: @escaping (_ data: [TxMetadataLabelCbor]?, _ error: Error?) -> Void)

Transaction metadata content in CBOR

Transaction metadata per label.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import BlockfrostSwift

let label = "label_example" // String | Metadata label
let count = 987 // Int | The number of results displayed on one page. (optional) (default to 100)
let page = 987 // Int | The page number for listing the results. (optional) (default to 1)
let order = "order_example" // SortOrder | The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional) (default to .asc)

// Transaction metadata content in CBOR
CardanoMetadataAPI.getTransactionMetadataCborForLabel(label: label, count: count, page: page, order: order) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
label String Metadata label
count Int The number of results displayed on one page. [optional] [default to 100]
page Int The page number for listing the results. [optional] [default to 1]
order SortOrder The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. [optional] [default to .asc]

Return type

[TxMetadataLabelCbor]

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransactionMetadataJsonForLabel

    open class func getTransactionMetadataJsonForLabel(label: String, count: Int? = nil, page: Int? = nil, order: SortOrder? = nil, completion: @escaping (_ data: [TxMetadataLabelJson]?, _ error: Error?) -> Void)

Transaction metadata content in JSON

Transaction metadata per label.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import BlockfrostSwift

let label = "label_example" // String | Metadata label
let count = 987 // Int | The number of results displayed on one page. (optional) (default to 100)
let page = 987 // Int | The page number for listing the results. (optional) (default to 1)
let order = "order_example" // SortOrder | The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional) (default to .asc)

// Transaction metadata content in JSON
CardanoMetadataAPI.getTransactionMetadataJsonForLabel(label: label, count: count, page: page, order: order) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
label String Metadata label
count Int The number of results displayed on one page. [optional] [default to 100]
page Int The page number for listing the results. [optional] [default to 1]
order SortOrder The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. [optional] [default to .asc]

Return type

[TxMetadataLabelJson]

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransactionMetadataLabels

    open class func getTransactionMetadataLabels(count: Int? = nil, page: Int? = nil, order: SortOrder? = nil, completion: @escaping (_ data: [TxMetadataLabel]?, _ error: Error?) -> Void)

Transaction metadata labels

List of all used transaction metadata labels.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import BlockfrostSwift

let count = 987 // Int | The number of results displayed on one page. (optional) (default to 100)
let page = 987 // Int | The page number for listing the results. (optional) (default to 1)
let order = "order_example" // SortOrder | The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional) (default to .asc)

// Transaction metadata labels
CardanoMetadataAPI.getTransactionMetadataLabels(count: count, page: page, order: order) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
count Int The number of results displayed on one page. [optional] [default to 100]
page Int The page number for listing the results. [optional] [default to 1]
order SortOrder The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. [optional] [default to .asc]

Return type

[TxMetadataLabel]

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]