Skip to content

CardanoTransactionsApi.md

Latest commit

 

History

History
589 lines (404 loc) · 19.4 KB

CardanoTransactionsApi.md

File metadata and controls

589 lines (404 loc) · 19.4 KB

blockfrost.api.CardanoTransactionsApi

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
txSubmitPost POST /tx/submit Submit a transaction
txsHashDelegationsGet GET /txs/{hash}/delegations Transaction delegation certificates
txsHashGet GET /txs/{hash} Specific transaction
txsHashMetadataCborGet GET /txs/{hash}/metadata/cbor Transaction metadata in CBOR
txsHashMetadataGet GET /txs/{hash}/metadata Transaction metadata
txsHashMirsGet GET /txs/{hash}/mirs Transaction MIRs
txsHashPoolRetiresGet GET /txs/{hash}/pool_retires Transaction stake pool retirement certificates
txsHashPoolUpdatesGet GET /txs/{hash}/pool_updates Transaction stake pool registration and update certificates
txsHashRedeemersGet GET /txs/{hash}/redeemers Transaction redeemers
txsHashStakesGet GET /txs/{hash}/stakes Transaction stake addresses certificates
txsHashUtxosGet GET /txs/{hash}/utxos Transaction UTXOs
txsHashWithdrawalsGet GET /txs/{hash}/withdrawals Transaction withdrawal

txSubmitPost

String txSubmitPost(contentType)

Submit a transaction

Submit an already serialized transaction to the network.

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().getCardanoTransactionsApi();
final String contentType = contentType_example; // String | 

try {
    final response = api.txSubmitPost(contentType);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txSubmitPost: $e\n');
}

Parameters

Name Type Description Notes
contentType String

Return type

String

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]

txsHashDelegationsGet

BuiltList txsHashDelegationsGet(hash)

Transaction delegation certificates

Obtain information about delegation certificates of a specific transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction.

try {
    final response = api.txsHashDelegationsGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashDelegationsGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction.

Return type

BuiltList<TxContentDelegationsInner>

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]

txsHashGet

TxContent txsHashGet(hash)

Specific transaction

Return content of the requested transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction

try {
    final response = api.txsHashGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction

Return type

TxContent

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]

txsHashMetadataCborGet

BuiltList txsHashMetadataCborGet(hash)

Transaction metadata in CBOR

Obtain the transaction metadata in CBOR.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction

try {
    final response = api.txsHashMetadataCborGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashMetadataCborGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction

Return type

BuiltList<TxContentMetadataCborInner>

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]

txsHashMetadataGet

BuiltList txsHashMetadataGet(hash)

Transaction metadata

Obtain the transaction metadata.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction

try {
    final response = api.txsHashMetadataGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashMetadataGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction

Return type

BuiltList<TxContentMetadataInner>

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]

txsHashMirsGet

BuiltList txsHashMirsGet(hash)

Transaction MIRs

Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction.

try {
    final response = api.txsHashMirsGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashMirsGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction.

Return type

BuiltList<TxContentMirsInner>

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]

txsHashPoolRetiresGet

BuiltList txsHashPoolRetiresGet(hash)

Transaction stake pool retirement certificates

Obtain information about stake pool retirements within a specific transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction

try {
    final response = api.txsHashPoolRetiresGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashPoolRetiresGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction

Return type

BuiltList<TxContentPoolRetiresInner>

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]

txsHashPoolUpdatesGet

BuiltList txsHashPoolUpdatesGet(hash)

Transaction stake pool registration and update certificates

Obtain information about stake pool registration and update certificates of a specific transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction

try {
    final response = api.txsHashPoolUpdatesGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashPoolUpdatesGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction

Return type

BuiltList<TxContentPoolCertsInner>

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]

txsHashRedeemersGet

BuiltList txsHashRedeemersGet(hash)

Transaction redeemers

Obtain the transaction redeemers.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction

try {
    final response = api.txsHashRedeemersGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashRedeemersGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction

Return type

BuiltList<TxContentRedeemersInner>

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]

txsHashStakesGet

BuiltList txsHashStakesGet(hash)

Transaction stake addresses certificates

Obtain information about (de)registration of stake addresses within a transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction.

try {
    final response = api.txsHashStakesGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashStakesGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction.

Return type

BuiltList<TxContentStakeAddrInner>

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]

txsHashUtxosGet

TxContentUtxo txsHashUtxosGet(hash)

Transaction UTXOs

Return the inputs and UTXOs of the specific transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction

try {
    final response = api.txsHashUtxosGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashUtxosGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction

Return type

TxContentUtxo

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]

txsHashWithdrawalsGet

BuiltList txsHashWithdrawalsGet(hash)

Transaction withdrawal

Obtain information about withdrawals of a specific transaction.

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().getCardanoTransactionsApi();
final String hash = 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b; // String | Hash of the requested transaction.

try {
    final response = api.txsHashWithdrawalsGet(hash);
    print(response);
} catch on DioError (e) {
    print('Exception when calling CardanoTransactionsApi->txsHashWithdrawalsGet: $e\n');
}

Parameters

Name Type Description Notes
hash String Hash of the requested transaction.

Return type

BuiltList<TxContentWithdrawalsInner>

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]