openapi

This API is exposed by the Babylon Radix Gateway to enable clients to efficiently query current and historic state on the RadixDLT ledger, and intelligently handle transaction submission.

It is designed for use by wallets and explorers, and for light queries from front-end dApps. For exchange/asset integrations, back-end dApp integrations, or simple use cases, you should consider using the Core API on a Node. A Gateway is only needed for reading historic snapshots of ledger states or a more robust set-up.

The Gateway API is implemented by the Network Gateway, which is configured to read from full node(s) to extract and index data from the network.

This document is an API reference documentation, visit User Guide to learn more about how to run a Gateway of your own.

Migration guide

Please see the latest release notes.

Integration and forward compatibility guarantees

All responses may have additional fields added at any release, so clients are advised to use JSON parsers which ignore unknown fields on JSON objects.

When the Radix protocol is updated, new functionality may be added, and so discriminated unions returned by the API may need to be updated to have new variants added, corresponding to the updated data. Clients may need to update in advance to be able to handle these new variants when a protocol update comes out.

On the very rare occasions we need to make breaking changes to the API, these will be warned in advance with deprecation notices on previous versions. These deprecation notices will include a safe migration path. Deprecation notes or breaking changes will be flagged clearly in release notes for new versions of the Gateway.

The Gateway DB schema is not subject to any compatibility guarantees, and may be changed at any release. DB changes will be flagged in the release notes so clients doing custom DB integrations can prepare.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: v1.6.1
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/api.dart';


final api_instance = StateApi();
final stateAccountAuthorizedDepositorsPageRequest = StateAccountAuthorizedDepositorsPageRequest(); // StateAccountAuthorizedDepositorsPageRequest | 

try {
    final result = api_instance.accountAuthorizedDepositorsPage(stateAccountAuthorizedDepositorsPageRequest);
    print(result);
} catch (e) {
    print('Exception when calling StateApi->accountAuthorizedDepositorsPage: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://mainnet.radixdlt.com

Class Method HTTP request Description
StateApi accountAuthorizedDepositorsPage POST /state/account/page/authorized-depositors Get Account authorized depositors
StateApi accountLockerVaultsPage POST /state/account-locker/page/vaults Get Account Locker Vaults Page
StateApi accountLockersTouchedAt POST /state/account-lockers/touched-at Get Most Recent Touch of Account Lockers
StateApi accountResourcePreferencesPage POST /state/account/page/resource-preferences Get Account resource preferences
StateApi entityFungibleResourceVaultPage POST /state/entity/page/fungible-vaults/ Get page of Global Entity Fungible Resource Vaults
StateApi entityFungiblesPage POST /state/entity/page/fungibles/ Get page of Global Entity Fungible Resource Balances
StateApi entityMetadataPage POST /state/entity/page/metadata Get Entity Metadata Page
StateApi entityNonFungibleIdsPage POST /state/entity/page/non-fungible-vault/ids Get page of Non-Fungibles in Vault
StateApi entityNonFungibleResourceVaultPage POST /state/entity/page/non-fungible-vaults/ Get page of Global Entity Non-Fungible Resource Vaults
StateApi entityNonFungiblesPage POST /state/entity/page/non-fungibles/ Get page of Global Entity Non-Fungible Resource Balances
StateApi entitySchemaPage POST /state/entity/page/schemas Get Entity Schema Page
StateApi keyValueStoreData POST /state/key-value-store/data Get KeyValueStore Data
StateApi keyValueStoreKeys POST /state/key-value-store/keys Get KeyValueStore Keys
StateApi nonFungibleData POST /state/non-fungible/data Get Non-Fungible Data
StateApi nonFungibleIds POST /state/non-fungible/ids Get page of Non-Fungible Ids in Resource Collection
StateApi nonFungibleLocation POST /state/non-fungible/location Get Non-Fungible Location
StateApi packageBlueprintPage POST /state/package/page/blueprints Get Package Blueprints Page
StateApi packageCodePage POST /state/package/page/codes Get Package Codes Page
StateApi stateEntityDetails POST /state/entity/details Get Entity Details
StateApi stateValidatorsList POST /state/validators/list Get Validators List
StatisticsApi validatorsUptime POST /statistics/validators/uptime Get Validators Uptime
StatusApi gatewayStatus POST /status/gateway-status Get Gateway Status
StatusApi networkConfiguration POST /status/network-configuration Get Network Configuration
StreamApi streamTransactions POST /stream/transactions Get Transactions Stream
TransactionApi accountDepositPreValidation POST /transaction/account-deposit-pre-validation PreValidate deposit of resources to an account
TransactionApi transactionCommittedDetails POST /transaction/committed-details Get Committed Transaction Details
TransactionApi transactionConstruction POST /transaction/construction Get Construction Metadata
TransactionApi transactionPreview POST /transaction/preview Preview Transaction
TransactionApi transactionStatus POST /transaction/status Get Transaction Status
TransactionApi transactionSubmit POST /transaction/submit Submit Transaction

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Libraries

api