/neblio-api-lib-php

Primary LanguagePHP

NeblioAPI

APIs for Interacting with NTP1 Tokens & The Neblio Blockchain

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

  • API version: 1.3.0
  • Package version: 1.2.1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/NeblioTeam/neblio-api-lib-php.git"
    }
  ],
  "require": {
    "NeblioTeam/neblio-api-lib-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/NeblioAPI/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new NeblioAPI\Api\InsightApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$address = 'address_example'; // string | Address

try {
    $result = $apiInstance->getAddress($address);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InsightApi->getAddress: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://ntp1node.nebl.io

Class Method HTTP request Description
InsightApi getAddress GET /ins/addr/{address} Returns address object
InsightApi getAddressBalance GET /ins/addr/{address}/balance Returns address balance in sats
InsightApi getAddressTotalReceived GET /ins/addr/{address}/totalReceived Returns total received by address in sats
InsightApi getAddressTotalSent GET /ins/addr/{address}/totalSent Returns total sent by address in sats
InsightApi getAddressUnconfirmedBalance GET /ins/addr/{address}/unconfirmedBalance Returns address unconfirmed balance in sats
InsightApi getAddressUtxos GET /ins/addr/{address}/utxo Returns all UTXOs at a given address
InsightApi getBlock GET /ins/block/{blockhash} Returns information regarding a Neblio block
InsightApi getBlockIndex GET /ins/block-index/{blockindex} Returns block hash of block
InsightApi getRawTx GET /ins/rawtx/{txid} Returns raw transaction hex
InsightApi getStatus GET /ins/status Utility API for calling several blockchain node functions
InsightApi getSync GET /ins/sync Get node sync status
InsightApi getTx GET /ins/tx/{txid} Returns transaction object
InsightApi getTxs GET /ins/txs Get transactions by block or address
InsightApi sendTx POST /ins/tx/send Broadcasts a signed raw transaction to the network (not NTP1 specific)
JSONRPCApi jsonRpc POST / Send a JSON-RPC call to a localhost neblio-Qt or nebliod node
NTP1Api broadcastTx POST /ntp1/broadcast Broadcasts a signed raw transaction to the network
NTP1Api burnToken POST /ntp1/burntoken Builds a transaction that burns an NTP1 Token
NTP1Api getAddressInfo GET /ntp1/addressinfo/{address} Information On a Neblio Address
NTP1Api getTokenHolders GET /ntp1/stakeholders/{tokenid} Get Addresses Holding a Token
NTP1Api getTokenId GET /ntp1/tokenid/{tokensymbol} Returns the tokenId representing a token
NTP1Api getTokenMetadata GET /ntp1/tokenmetadata/{tokenid} Get Metadata of Token
NTP1Api getTokenMetadataOfUtxo GET /ntp1/tokenmetadata/{tokenid}/{utxo} Get UTXO Metadata of Token
NTP1Api getTransactionInfo GET /ntp1/transactioninfo/{txid} Information On an NTP1 Transaction
NTP1Api issueToken POST /ntp1/issue Builds a transaction that issues a new NTP1 Token
NTP1Api sendToken POST /ntp1/sendtoken Builds a transaction that sends an NTP1 Token
TestnetFaucetApi testnetGetFaucet GET /testnet/faucet Withdraws testnet NEBL to the specified address
TestnetInsightApi testnetGetAddress GET /testnet/ins/addr/{address} Returns address object
TestnetInsightApi testnetGetAddressBalance GET /testnet/ins/addr/{address}/balance Returns address balance in sats
TestnetInsightApi testnetGetAddressTotalReceived GET /testnet/ins/addr/{address}/totalReceived Returns total received by address in sats
TestnetInsightApi testnetGetAddressTotalSent GET /testnet/ins/addr/{address}/totalSent Returns total sent by address in sats
TestnetInsightApi testnetGetAddressUnconfirmedBalance GET /testnet/ins/addr/{address}/unconfirmedBalance Returns address unconfirmed balance in sats
TestnetInsightApi testnetGetAddressUtxos GET /testnet/ins/addr/{address}/utxo Returns all UTXOs at a given address
TestnetInsightApi testnetGetBlock GET /testnet/ins/block/{blockhash} Returns information regarding a Neblio block
TestnetInsightApi testnetGetBlockIndex GET /testnet/ins/block-index/{blockindex} Returns block hash of block
TestnetInsightApi testnetGetRawTx GET /testnet/ins/rawtx/{txid} Returns raw transaction hex
TestnetInsightApi testnetGetStatus GET /testnet/ins/status Utility API for calling several blockchain node functions
TestnetInsightApi testnetGetSync GET /testnet/ins/sync Get node sync status
TestnetInsightApi testnetGetTx GET /testnet/ins/tx/{txid} Returns transaction object
TestnetInsightApi testnetGetTxs GET /testnet/ins/txs Get transactions by block or address
TestnetInsightApi testnetSendTx POST /testnet/ins/tx/send Broadcasts a signed raw transaction to the network (not NTP1 specific)
TestnetNTP1Api testnetBroadcastTx POST /testnet/ntp1/broadcast Broadcasts a signed raw transaction to the network
TestnetNTP1Api testnetBurnToken POST /testnet/ntp1/burntoken Builds a transaction that burns an NTP1 Token
TestnetNTP1Api testnetGetAddressInfo GET /testnet/ntp1/addressinfo/{address} Information On a Neblio Address
TestnetNTP1Api testnetGetTokenHolders GET /testnet/ntp1/stakeholders/{tokenid} Get Addresses Holding a Token
TestnetNTP1Api testnetGetTokenId GET /testnet/ntp1/tokenid/{tokensymbol} Returns the tokenId representing a token
TestnetNTP1Api testnetGetTokenMetadata GET /testnet/ntp1/tokenmetadata/{tokenid} Get Metadata of Token
TestnetNTP1Api testnetGetTokenMetadataOfUtxo GET /testnet/ntp1/tokenmetadata/{tokenid}/{utxo} Get UTXO Metadata of Token
TestnetNTP1Api testnetGetTransactionInfo GET /testnet/ntp1/transactioninfo/{txid} Information On an NTP1 Transaction
TestnetNTP1Api testnetIssueToken POST /testnet/ntp1/issue Builds a transaction that issues a new NTP1 Token
TestnetNTP1Api testnetSendToken POST /testnet/ntp1/sendtoken Builds a transaction that sends an NTP1 Token

Documentation For Models

Documentation For Authorization

rpcAuth

  • Type: HTTP basic authentication

Author