Skip to content

CardanoMetadataApi.md

Latest commit

 

History

History
173 lines (123 loc) · 7.03 KB

CardanoMetadataApi.md

File metadata and controls

173 lines (123 loc) · 7.03 KB

blockfrost.api.CardanoMetadataApi

Load the API package

import 'package:blockfrost/api.dart';

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

Method HTTP request Description
metadataTxsLabelsGet GET /metadata/txs/labels Transaction metadata labels
metadataTxsLabelsLabelCborGet GET /metadata/txs/labels/{label}/cbor Transaction metadata content in CBOR
metadataTxsLabelsLabelGet GET /metadata/txs/labels/{label} Transaction metadata content in JSON

metadataTxsLabelsGet

BuiltList metadataTxsLabelsGet(count, page, order)

Transaction metadata labels

List of all used transaction metadata labels.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoMetadataApi();
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.metadataTxsLabelsGet(count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoMetadataApi->metadataTxsLabelsGet: $e\n');
}

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 String 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

BuiltList<TxMetadataLabelsInner>

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]

metadataTxsLabelsLabelCborGet

BuiltList metadataTxsLabelsLabelCborGet(label, count, page, order)

Transaction metadata content in CBOR

Transaction metadata per label.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoMetadataApi();
final String label = 1990; // String | Metadata label
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.metadataTxsLabelsLabelCborGet(label, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoMetadataApi->metadataTxsLabelsLabelCborGet: $e\n');
}

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 String 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

BuiltList<TxMetadataLabelCborInner>

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]

metadataTxsLabelsLabelGet

BuiltList metadataTxsLabelsLabelGet(label, count, page, order)

Transaction metadata content in JSON

Transaction metadata per label.

Example

import 'package:blockfrost/api.dart';
// TODO Configure API key authorization: ApiKeyAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ApiKeyAuth').apiKeyPrefix = 'Bearer';

final api = Blockfrost().getCardanoMetadataApi();
final String label = 1990; // String | Metadata label
final int count = 56; // int | The number of results displayed on one page.
final int page = 56; // int | The page number for listing the results.
final String order = order_example; // String | 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. 

try {
    final response = api.metadataTxsLabelsLabelGet(label, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoMetadataApi->metadataTxsLabelsLabelGet: $e\n');
}

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 String 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

BuiltList<TxMetadataLabelJsonInner>

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]