Jump to Content
Quant Developer Hub
HomeGuidesAPI ReferenceRelease Notes
Quant Connect LoginTalk to usQuant Developer Hub
API Reference
Quant Connect LoginTalk to us
HomeGuidesAPI ReferenceRelease Notes

GET STARTED

  • How to access Overledger APIs
  • API Versioning
  • Overledger Pattern
  • Transaction statuses
  • Supported blockchain networks

Overledger OAuth2 Token API

  • Retrieve OAuth2 Token
    • Retrieve OAuth2 Tokenpost

TRANSACT API

  • Supported Quant smart non-fungible tokens
    • Retrieve a list of ERC721 and QRC721 tokensget
  • Supported Quant smart fungible tokens
    • Retrieve a list of ERC20 and QRC20 tokensget
  • Make a payment
    • Prepare a DLT transaction for signingpost
    • Execute a transaction on a DLTpost
    • Prepare a DLT native transactionpost
    • Execute a native transaction on the DLTpost

SEARCH API

  • Transaction search
    • Submit a search for a transaction.post
  • Address search
    • Submit a search for an address sequence.post
    • Submit a search for an address balance.post
  • Block search
    • Submit a search for a block.post
  • Smart contract search
    • Submit a search for a smart contract query.post
  • UTXO status search
    • Submit a search for an UTXO.post

WEBHOOKS API

  • Create webhook for account updates
    • Receive updates about transactions for an accountpost
    • Retrieve information about an Account Webhookget
    • Retrieve a list of Webhooks for Accountsget
    • Update the Callback URL for an Account Webhookpatch
    • Remove an Account Webhookdelete
  • Create webhook for smart contract events
    • Receive updates about transactions for a smart contract eventpost
    • Retrieve information about a Smart Contract Event Webhookget
    • Retrieve a list of Webhooks for Smart Contract Eventsget
    • Update the Callback URL for a Smart Contract Event Webhookpatch
    • Remove a Smart Contract Event Webhookdelete

Transaction signing

  • Sign a transaction
    • Sign a transaction in Sandbox with application keypost

SMART CONTRACT API

  • Create a smart contract read transaction
    • Submit a smart contract read requestpost
  • Create a smart contract write transaction
    • Prepare a Smart Contract Write transaction for signingpost
    • Execute a signed transaction to the requested DLTpost
  • Create a smart contract deployment transaction
    • Prepare a Smart Contract Deployment transaction for signingpost
    • Execute a signed smart contract deployment transaction to the requested DLTpost

TOKEN API

  • Quant smart fungible tokens
    • Create a Quant smart fungible tokens credit transaction
      • Prepare a QRC20 token credit transaction for signingpost
    • Create a Quant smart fungible tokens debit transaction
      • Prepare a QRC20 token debit transaction for signingpost
    • Create and pay from a Quant smart fungible tokens shared account
      • Prepare a request for a QRC20 shared accountpost
    • Manage Quant smart fungible tokens supply
      • Prepare a request to manage QRC20 token supplypost
    • Retrieve approved account information for a Quant smart fungible token
      • Retrieve whether an account is approved to make payments on behalf of another account for a particular QRC20 token.post
    • Retrieve account balance for a Quant smart fungible token
      • Retrieve the balance of QRC20 tokens for an accountpost
    • Retrieve approved account allowance for a Quant smart fungible token
      • Retrieve how many QRC20 tokens an address is allowed to debitpost
  • Quant smart non fungible tokens
    • Create a Quant smart non-fungible token collection transaction
      • Prepare a QRC721 token collection transaction for signingpost
    • Create a Quant smart non-fungible token transfer transaction
      • Prepare a QRC721 token transfer transaction for signingpost
    • Manage Quant smart non-fungible tokens supply
      • Prepare a transaction to manage QRC721 token supplypost
    • Retrieve approved account information of a Quant smart non-fungible token
      • Retrieve which account is approved to collect a QRC721 tokenpost
    • Retrieve the count of Quant smart non-fungible tokens
      • Retrieve the count of a QRC721 token for a particular accountpost
    • Retrieve owner information for a Quant smart non-fungible token
      • Retrieve which account currently owns a specific QRC721 tokenpost
    • Retrieve URI information for a Quant smart non-fungible token
      • Retrieve the URI for a specific QRC721 tokenpost
  • Retrieve supply information for a Quant smart token
    • Retrieve how many QRC tokens are currently in supplypost
  • Retrieve contract owner information of a Quant smart token
    • Retrieve which account has contract owner permissions for a QRC tokenpost

Authorise API

  • Sign a transaction with user's key
    • Sign a transaction with application keypost
  • Manage users and keys
    • Get User Detailsget
    • Create Userpost
    • Create Keypost
    • Delete Userdelete
    • Delete User Keydelete

BRIDGE API

  • Create Asset Transfer for Bridge
    • Prepare asset transfer for bridgepost
    • Execute asset transfer for bridgepost
  • Retrieve Information About an Asset Transfer
    • Retrieve information about an asset transferget

Overledger Preview Sandboxes

  • Digital Currency Sandbox
    • Read Token Balancepost
    • Read Bond Informationpost
    • Issue a Bondpost
    • Read Bond Balancepost
    • Purchase a Bondpost
    • Redeem a Bondpost
    • Transfer Tokenspost
  • SATP Sandbox
    • Initiate a digital asset transferpost
    • Submit a transfer proposalpost
    • Receive a transfer proposalpost
    • Commence the asset transferpost
    • Acknowledge transfer commencementpost
    • Submit lock assertionpost
    • Acknowledge lock assertionpost
    • Prepare for transfer commitmentpost
    • Acknowledge commitment readinesspost
    • Finalize the asset transfer commitmentpost
    • Acknowledge final commitmentpost
    • Mark transfer as completepost
    • Get gateway and network capabilitiesget
    • Retrieve session detailsget
    • Retrieve transfer detailsget
  • SAEP Sandbox
    • Initiate a digital asset exchangepost
    • Submit an exchange proposalpost
    • Receive an exchange proposalpost
    • Commence the asset exchangepost
    • Acknowledge exchange commencementpost
    • Submit lock assertionpost
    • Acknowledge lock assertionpost
    • Prepare for exchange commitmentpost
    • Acknowledge commitment readinesspost
    • Finalize the asset exchange commitmentpost
    • Acknowledge final commitmentpost
    • Mark exchange as completepost
    • Get gateway and network capabilitiesget
    • Retrieve session detailsget
    • Retrieve exchange detailsget

Overledger Preview APIs

  • Connector: Hyperledger Fabric
    • Execute a signed smart contract write transaction to the requested DLTpost
    • Prepare a Smart Contract Write transaction for signingpost
    • Submit a Smart Contract Read requestpost
    • Create an accountpost
    • Submit a search for a blockpost
    • Submit a search for a transactionpost
  • App: Advanced Access Control
    • Execute a signed smart contract write transaction to the requested DLT (with validation)post
    • Execute a signed smart contract deployment transaction to the requested DLT (with validation)post
    • Prepare a Smart Contract Write transaction for signing (with validation)post
    • Prepare a Smart Contract Deployment transaction for signing (with validation)post
    • Create a validation schema for preparing a smart contract write transactionpost
    • Create a validation schema for preparing a smart contract deployment transactionpost
    • Get validation schema by IDget
    • Get validation schemas for clientIdget
    • Delete validation schema by IDdelete
  • App: Automated Smart Contract Audit
    • Trigger Automated Auditpost
  • Connector: Solana
    • Read Address Balancepost
    • Prepare a Transactionpost
    • Execute a Transactionpost
  • Connectors: Combined Calls
    • Read Transactionget
    • Read a Blockget
  • Overwallet
    • Create an hdAccountIdpost
    • Generate a keypost
    • Sign a transactionpost
    • Get an addresspost
    • Get a public keypost
    • Get a list of hdAccountIdspost
    • Get a list of assetspost
  • App: XRPL Faucet
    • Get Testnet tokenspost

SATP Sandbox

For establishment of gateways conforming to IETF's Secure Asset Transfer Protocol standard: https://datatracker.ietf.org/group/satp/about/.

This standard allows for transferring of assets between two separate ledgers.