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

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
Create webhook for smart contract events

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
Quant smart non fungible tokens
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

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
SATP Sandbox
SAEP Sandbox

Overledger Preview APIs

Connector: Hyperledger Fabric
App: Advanced Access Control
App: Automated Smart Contract Audit
- Trigger Automated Auditpost
Connector: Solana
Connectors: Combined Calls
- Read Transactionget
- Read a Blockget
Overwallet
App: XRPL Faucet
- Get Testnet tokenspost

Submit a smart contract read request

post https://api.overledger.dev/api/smart-contracts/read

Submits a query for reading a smart contract function on a requested DLT

Body Params

location

object

required

The blockchain network and technology the transaction will be submitted to

functionName

string

required

inputParameters

array of objects

inputParameters

smartContractId

string

required

length between 0 and 500

The smart contract that will be monitored for transaction updates

outputParameters

array of objects

outputParameters

Headers

API-Version

string

required

Responses

Response body

object

location

object

required

The blockchain network and technology the transaction will be submitted to

technology

string

required

length between 0 and 30

The technology of the blockchain that the transaction will be submitted to

network

string

required

length between 0 and 30

The blockchain network the transaction will be submitted to

functionName

string

required

The function on on the smart contract

smartContractId

string

required

The ID for the smart contract which is to be invoked

outputParameters

array of objects

required

The output parameter return for function call

outputParameters*

object

type

string

required

length between 0 and 20

The type of output parameter required e.g., address, string

value

object

required

The parameter value

Has additional fields

key

string

length between 0 and 20

Response body

object

code

int32

The HTTP status code generated by the error

errorMessageExtraDetails

string

Additional information to help identify and correct the problem

type

string

Problem type

title

string

Summary of the error that has occurred

message

string

Detailed description of the error

Response body

object

code

int32

The HTTP status code generated by the error

errorMessageExtraDetails

string

Additional information to help identify and correct the problem

type

string

Problem type

title

string

Summary of the error that has occurred

message

string

Detailed description of the error

Response body

object

code

int32

The HTTP status code generated by the error

errorMessageExtraDetails

string

Additional information to help identify and correct the problem

type

string

Problem type

title

string

Summary of the error that has occurred

message

string

Detailed description of the error

Updated 5 months ago

Sign a transaction in Sandbox with application key

Create a smart contract write transaction

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.overledger.dev/api/smart-contracts/read \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
14
 
1
{
2
  "location": {
3
    "technology": "ethereum",
4
    "network": "ethereum sepolia testnet"
5
  },
6
  "functionName": "readVeryLongFunctionNameReadVeryLongFunctionNameReadVeryLongFunctionName",
7
  "smartContractId": "0x3a637d769ed8530b483eeae70923d73dbad916c6",
8
  "outputParameters": [
9
    {
10
      "type": "address",
11
      "value": "0x1789d90438333751fdcca0d03d8952168b99ef02"
12
    }
13
  ]
14
}

Updated 5 months ago

Sign a transaction in Sandbox with application key

Create a smart contract write transaction

Did this page help you?

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
Execute a native transaction on the DLTpost
Prepare a DLT native transactionpost
Execute a transaction on a DLTpost
Prepare a DLT transaction for signingpost

SEARCH API
Transaction search
Submit a search for a transaction.post
Address search
Submit a search for an address balance.post
Submit a search for an address sequence.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
Remove an Account Webhookdelete
Update the Callback URL for an Account Webhookpatch
Retrieve a list of Webhooks for Accountsget
Retrieve information about an Account Webhookget
Receive updates about transactions for an accountpost
Create webhook for smart contract events
Remove a Smart Contract Event Webhookdelete
Update the Callback URL for a Smart Contract Event Webhookpatch
Retrieve a list of Webhooks for Smart Contract Eventsget
Retrieve information about a Smart Contract Event Webhookget
Receive updates about transactions for a smart contract eventpost

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
Execute a signed transaction to the requested DLTpost
Prepare a Smart Contract Write transaction for signingpost
Create a smart contract deployment transaction
Execute a signed smart contract deployment transaction to the requested DLTpost
Prepare a Smart Contract Deployment transaction for signingpost

TOKEN API
Quant smart fungible tokens
Retrieve approved account allowance for a Quant smart fungible token
Retrieve how many QRC20 tokens an address is allowed to debitpost
Retrieve account balance for a Quant smart fungible token
Retrieve the balance of QRC20 tokens for an accountpost
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
Manage Quant smart fungible tokens supply
Prepare a request to manage QRC20 token supplypost
Create and pay from a Quant smart fungible tokens shared account
Prepare a request for a QRC20 shared accountpost
Create a Quant smart fungible tokens debit transaction
Prepare a QRC20 token debit transaction for signingpost
Create a Quant smart fungible tokens credit transaction
Prepare a QRC20 token credit transaction for signingpost
Quant smart non fungible tokens
Retrieve URI information for a Quant smart non-fungible token
Retrieve the URI for a specific QRC721 tokenpost
Retrieve owner information for a Quant smart non-fungible token
Retrieve which account currently owns a specific QRC721 tokenpost
Retrieve the count of Quant smart non-fungible tokens
Retrieve the count of a QRC721 token for a particular accountpost
Retrieve approved account information of a Quant smart non-fungible token
Retrieve which account is approved to collect a QRC721 tokenpost
Manage Quant smart non-fungible tokens supply
Prepare a transaction to manage QRC721 token supplypost
Create a Quant smart non-fungible token transfer transaction
Prepare a QRC721 token transfer transaction for signingpost
Create a Quant smart non-fungible token collection transaction
Prepare a QRC721 token collection transaction for signingpost
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
Delete User Keydelete
Delete Userdelete
Create Keypost
Create Userpost
Get User Detailsget

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

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

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

200OK

400Bad Request

401Unauthorized

503Service Unavailable