Skip to content

Latest commit

 

History

History
225 lines (156 loc) · 8.32 KB

NutLinkApi.md

File metadata and controls

225 lines (156 loc) · 8.32 KB

blockfrost.api.NutLinkApi

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
nutlinkAddressGet GET /nutlink/{address}
nutlinkAddressTickersGet GET /nutlink/{address}/tickers
nutlinkAddressTickersTickerGet GET /nutlink/{address}/tickers/{ticker}
nutlinkTickersTickerGet GET /nutlink/tickers/{ticker}

nutlinkAddressGet

NutlinkAddress nutlinkAddressGet(address)

List metadata about specific address

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().getNutLinkApi();
final String address = address_example; // String | 

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

Parameters

Name Type Description Notes
address String

Return type

NutlinkAddress

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]

nutlinkAddressTickersGet

BuiltList nutlinkAddressTickersGet(address, count, page, order)

List of records of a specific ticker

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().getNutLinkApi();
final String address = address_example; // String | 
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.nutlinkAddressTickersGet(address, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NutLinkApi->nutlinkAddressTickersGet: $e\n');
}

Parameters

Name Type Description Notes
address String
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<NutlinkAddressTickersInner>

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]

nutlinkAddressTickersTickerGet

BuiltList nutlinkAddressTickersTickerGet(address, ticker, count, page, order)

List of records of a specific ticker

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().getNutLinkApi();
final String address = address_example; // String | 
final String ticker = ticker_example; // String | 
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.nutlinkAddressTickersTickerGet(address, ticker, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NutLinkApi->nutlinkAddressTickersTickerGet: $e\n');
}

Parameters

Name Type Description Notes
address String
ticker String
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<NutlinkAddressTickerInner>

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]

nutlinkTickersTickerGet

BuiltList nutlinkTickersTickerGet(ticker, count, page, order)

List of records of a specific ticker

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().getNutLinkApi();
final String ticker = ticker_example; // String | 
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.nutlinkTickersTickerGet(ticker, count, page, order);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NutLinkApi->nutlinkTickersTickerGet: $e\n');
}

Parameters

Name Type Description Notes
ticker String
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<NutlinkTickersTickerInner>

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]