Select Page

BCware Platform API Introduction

Welcome to the BCware APIs. Here at BCware, our mission is to provide a seamless integration layer between centralized legacy systems and decentralized digital asset infrastructures. These APIs serve that mission by providing a transparent mechanism to integrate your existing application infrastructure functionality with any underlying DLT platform of your choice.

Platform CeFi APIs

AddAccount

post /platform/api/v1/bcflow/offchain/internal/CeFi/AddAccount

Create Account. (platformApiV1BcflowOffchainInternalCeFiAddAccountPost)
Enables creating account and adding up parity account details

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Account models.Account (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.Account

400

GetAccount

post /platform/api/v1/bcflow/offchain/internal/CeFi/GetAccount

Get Account (platformApiV1BcflowOffchainInternalCeFiGetAccountPost)
Enables getting the account details

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetAccount models.GetAccount (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.Account

400

OffChainPostgres

post /platform/api/v1/bcflow/offchain/internal/CeFi/OffChainPostgres

To add event log in postgres. (platformApiV1BcflowOffchainInternalCeFiOffChainPostgresPost)
To add event log in postgres

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.EventLog models.EventLog (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK models.EventLog

400

AddKyc

post /platform/api/v1/bcflow/offchain/internal/CeFi/AddKyc

Add KYC (platformApiV1BcflowOffchainInternalCeFiAddKycPost)
Enables adding KYC for an account

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Kyc models.Kyc (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.Kyc

400

ApproveKyc

post /platform/api/v1/bcflow/offchain/internal/CeFi/ApproveKyc

Approve KYC (platformApiV1BcflowOffchainInternalCeFiApproveKycPost)
Enables approving of KYC by asset manager

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.ApproveKyc models.ApproveKyc (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.Kyc

400

GetKyc

post /platform/api/v1/bcflow/offchain/internal/CeFi/GetKyc

Get KYC (platformApiV1BcflowOffchainInternalCeFiGetKycPost)
Enables getting the KYC detail

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetKyc models.GetKyc (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.Kyc

400

approvepurchaserequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/approvepurchaserequest

Approve purchase request (platformApiV1BcflowOffchainInternalCeFiApprovepurchaserequestPost)
Enables appoving of purchase request by asset manager

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.ApproveAmPurchase models.ApproveAmPurchase (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.AmPurchase

400

getpurchaserequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/getpurchaserequest

Get Purchase request (platformApiV1BcflowOffchainInternalCeFiGetpurchaserequestPost)
Enables to get the purchase request

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetAmPurchase models.GetAmPurchase (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.AmPurchase

400

raisepurchaserequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/raisepurchaserequest

Raise purchase request (platformApiV1BcflowOffchainInternalCeFiRaisepurchaserequestPost)
Enables to raise the purchase request for asset owner

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.AmPurchase models.AmPurchase (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.AmPurchase

400

AddStakeMeta

post /platform/api/v1/bcflow/offchain/internal/CeFi/AddStakeMeta

Add Stake Meta info (platformApiV1BcflowOffchainInternalCeFiAddStakeMetaPost)
Enables adding staking metadata

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.StakeMeta models.StakeMeta (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.StakeMeta

400

GetRedeemedStakeRequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/GetRedeemedStakeRequest

Get Redeemed stake request details (platformApiV1BcflowOffchainInternalCeFiGetRedeemedStakeRequestPost)
Enalbes to get stake request details which are redeemed

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetStakeMeta models.GetStakeMeta (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.StakeAssetPortfolio

400

GetStakeMeta

post /platform/api/v1/bcflow/offchain/internal/CeFi/GetStakeMeta

Get Stake Meta (platformApiV1BcflowOffchainInternalCeFiGetStakeMetaPost)
Enables to get stake metadata.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetStakeMeta models.GetStakeMeta (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.StakeMeta

400

GetStakeRequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/GetStakeRequest

Get raised stake request (platformApiV1BcflowOffchainInternalCeFiGetStakeRequestPost)
Enables to get the raised stake request

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetStakeAssetPortfolio models.GetStakeAssetPortfolio (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.StakeAssetPortfolio

400

raisestakerequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/raisestakerequest

Raise stake request (platformApiV1BcflowOffchainInternalCeFiRaisestakerequestPost)
Enables to raise the stake reuqest by asset owner

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.StakeAssetPortfolio models.StakeAssetPortfolio (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.StakeAssetPortfolio

400

redeemstakerequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/redeemstakerequest

Redeem stake (platformApiV1BcflowOffchainInternalCeFiRedeemstakerequestPost)
Enables to redeem stake

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.ApproveStakeAssetPortfolio models.ApproveStakeAssetPortfolio (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.StakeAssetPortfolio

400

approvestakerequest

post /platform/api/v1/bcflow/offchain/internal/CeFi/approvestakerequest

Approve stake request (platformApiV1BcflowOffchainInternalCeFiApprovestakerequestPost)
Enables approve of stake request by asset manager

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.ApproveStakeAssetPortfolio models.ApproveStakeAssetPortfolio (required)
Body Parameter — off chain postgres retrieve

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.StakeAssetPortfolio

400

KafkaPublisher

post /platform/bcflow/offchain/internal/CeFi/KafkaPublisher

Publish on Kafka topic. (platformBcflowOffchainInternalCeFiKafkaPublisherPost)
A Kafka client that publishes records to the Kafka cluster.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Publish models.Publish (required)
Body Parameter — Publish on Kafka topic

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK models.Publish

400

KafkaSubscriber

post /platform/bcflow/offchain/internal/CeFi/KafkaSubscriber

Subscribe Kafka topic. (platformBcflowOffchainInternalCeFiKafkaSubscriberPost)
A Kafka client that subscirbes records from the Kafka cluster.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Options models.Options (required)
Body Parameter — Subscribe Kafka topic

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK models.Options

400

ksql

post /platform/bcflow/offchain/internal/CeFi/ksql

Execute mutation query in kafka. (platformBcflowOffchainInternalCeFiKsqlPost)
Execute mutation query in kafka

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetKsqlInput models.GetKsqlInput (required)
Body Parameter — Execute mutation query in kafka

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetKsqlInput

400

KsqlSelect

post /platform/bcflow/offchain/internal/CeFi/KsqlSelect

Execute select query in kafka. (platformBcflowOffchainInternalCeFiKsqlSelectPost)
Execute select query in kafka

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetKsqlInput models.GetKsqlInput (required)
Body Parameter — Execute select query in kafka

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetKsqlInput

400

NatsPublisher

post /platform/bcflow/offchain/internal/CeFi/NatsPublisher

Publish on Nats subject. (platformBcflowOffchainInternalCeFiNatsPublisherPost)
A Nats client that publishes records to the Nats cluster.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Publish models.Publish (required)
Body Parameter — Publish on Nats subject

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK models.Publish

400

NatsSubscriber

post /platform/bcflow/offchain/internal/CeFi/NatsSubscriber

Subscribe Nats subject. (platformBcflowOffchainInternalCeFiNatsSubscriberPost)
A Nats client that subscirbes records from the Nats cluster.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Options models.Options (required)
Body Parameter — Subscribe Nats subject

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK models.Options

400

NgsPublisher

post /platform/bcflow/offchain/internal/CeFi/NgsPublisher

Publish on Ngs subject. (platformBcflowOffchainInternalCeFiNgsPublisherPost)
A Ngs client that publishes records to the Ngs cluster.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Publish models.Publish (required)
Body Parameter — Publish on Ngs subject

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK models.Publish

400

NgsSubscriber

post /platform/bcflow/offchain/internal/CeFi/NgsSubscriber

Subscribe Ngs subject. (platformBcflowOffchainInternalCeFiNgsSubscriberPost)
A Ngs client that subscirbes records from the Ngs cluster.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Options models.Options (required)
Body Parameter — Subscribe Ngs subject

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK models.Options

400

PlatformDeFiEthereumAPIs

deploycontract

post /platform/api/v1/runtime/onchain/external/DeFi/deploycontract

To perform executes DeployContract. (platformApiV1RuntimeOnchainExternalDeFiDeploycontractPost)
To perform executes DeployContract

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.TransactionOption models.TransactionOption (required)
Body Parameter — off chain postgres retrieve

Return type

String

Example data

Content-Type: application/json
{
  "bytes": [],
  "empty": true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

ok String

400

EthBlock

post /platform/flow/onchain/external/DeFi/EthBlock

Returns the number of the most recent block. (platformFlowOnchainExternalDeFiEthBlockPost)
Returns the number of the most recent block

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthBlockInput models.GetEthBlockInput (required)
Body Parameter — Returns the number of the most recent block

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthBlockInput

400

EthClient

post /platform/flow/onchain/external/DeFi/EthClient

Returns a list of addresses owned by client. (platformFlowOnchainExternalDeFiEthClientPost)
Returns a list of addresses owned by client

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthClientInput models.GetEthClientInput (required)
Body Parameter — Returns a list of addresses owned by client

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthClientInput

400

EthExecute

post /platform/flow/onchain/external/DeFi/EthExecute

Executes a new message call immediately without creating a transaction on the block chain. (platformFlowOnchainExternalDeFiEthExecutePost)
Executes a new message call immediately without creating a transaction on the block chain

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthExecuteInput models.GetEthExecuteInput (required)
Body Parameter — Executes a new message call immediately without creating a transaction on the block chain

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthExecuteInput

400

EthFeeMarket

post /platform/flow/onchain/external/DeFi/EthFeeMarket

Returns the current price per gas / fee history in wei. (platformFlowOnchainExternalDeFiEthFeeMarketPost)
Returns the current price per gas / fee history in wei

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthFeeMarketInput models.GetEthFeeMarketInput (required)
Body Parameter — Returns the current price per gas / fee history in wei

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthFeeMarketInput

400

EthFilter

post /platform/flow/onchain/external/DeFi/EthFilter

Filter options to track new logs matching the topics specified. (platformFlowOnchainExternalDeFiEthFilterPost)
Filter options to track new logs matching the topics specified.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthFilterInput models.GetEthFilterInput (required)
Body Parameter — Filter options to track new logs matching the topics specified

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthFilterInput

400

EthMining

post /platform/flow/onchain/external/DeFi/EthMining

Returns true if client is actively mining new blocks. (platformFlowOnchainExternalDeFiEthMiningPost)
Returns true if client is actively mining new blocks

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthMiningInput models.GetEthMiningInput (required)
Body Parameter — Returns true if client is actively mining new blocks

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthMiningInput

400

EthSign

post /platform/flow/onchain/external/DeFi/EthSign

The sign method calculates an Ethereum specific signature with keccak256 fuction . (platformFlowOnchainExternalDeFiEthSignPost)
The sign method calculates an Ethereum specific signature with keccak256 fuction

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthSignInput models.GetEthSignInput (required)
Body Parameter — The sign method calculates an Ethereum specific signature with keccak256 fuction

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthSignInput

400

EthState

post /platform/flow/onchain/external/DeFi/EthState

Returns the value for a given address. (platformFlowOnchainExternalDeFiEthStatePost)
Returns the value for a given address

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthStateInput models.GetEthStateInput (required)
Body Parameter — Returns the value for a given address

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthStateInput

400

EthSubmit

post /platform/flow/onchain/external/DeFi/EthSubmit

Creates new message call transaction or a contract creation, if the data field contains code. (platformFlowOnchainExternalDeFiEthSubmitPost)
Creates new message call transaction or a contract creation, if the data field contains code

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthSubmitInput models.GetEthSubmitInput (required)
Body Parameter — Creates new message call transaction or a contract creation, if the data field contains code

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthSubmitInput

400

EthTransaction

post /platform/flow/onchain/external/DeFi/EthTransaction

Returns the information about a transaction requested. (platformFlowOnchainExternalDeFiEthTransactionPost)
Returns the information about a transaction requested by transaction hash. In the response object, blockHash, blockNumber, and transactionIndex are null when the transaction is pending

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetEthTransactionInput models.GetEthTransactionInput (required)
Body Parameter — Returns the information about a transaction requested

Return type

Example data

Content-Type: application/json
{"empty": false}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

desc models.GetEthTransactionInput

400

startstaking

post /platform/api/v1/bcflow/onchain/external/DeFi/startstaking

To perform executes DeployContract. (platformApiV1BcflowOnchainExternalDeFiStartstakingPost)
To perform executes DeployContract

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.TransactionOption models.TransactionOption (required)
Body Parameter — off chain postgres retrieve

Return type

String

Example data

Content-Type: application/json
{
  "bytes": [],
  "empty": true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

ok String

400

withdrawstake

post /platform/api/v1/bcflow/onchain/external/DeFi/withdrawstake

To perform executes WithdrawStake. (platformApiV1BcflowOnchainExternalDeFiWithdrawstakePost)
To perform executes WithdrawStake

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.TransactionOption models.TransactionOption (required)
Body Parameter — off chain postgres retrieve

Return type

String

Example data

Content-Type: application/json
{
  "bytes": [],
  "empty": true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

ok String

400

PlatformDeFiOnflowDapperAPIs

generateKey

post /platform/api/v1/runtime/onchain/external/DeFi/account/generateKey

Generate pair of Public and Private key. (platformApiV1RuntimeOnchainExternalDeFiAccountGenerateKeyPost)
Enables creation of public and private key with requested seed data

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.CreateKeyModel models.CreateKeyModel (required)
Body Parameter — generate key

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

createAccount

post /platform/api/v1/runtime/onchain/external/DeFi/account/createAccount

Create Account with Public and Private key. (platformApiV1RuntimeOnchainExternalDeFiAccountCreateAccountPost)
Enables creation of account and deployment of contract

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.CreateAccountModel models.CreateAccountModel (required)
Body Parameter — create account

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

setupAccount

post /platform/api/v1/runtime/onchain/external/DeFi/account/setupAccount

Setup account for services. (platformApiV1RuntimeOnchainExternalDeFiAccountSetupAccountPost)
Enables subscription of services for account based on cdc file selected. Setup Account for FT and NFT and Market Place by passing the respective cdc file as argument.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.SetUpAccountModel models.SetUpAccountModel (required)
Body Parameter — setup account

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

getBalance

post /platform/api/v1/bcflow/onchain/external/DeFi/ft/getBalance

Get Account balance. (platformApiV1BcflowOnchainExternalDeFiFtGetBalancePost)
Enables getting account balance.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetBalanceModel models.GetBalanceModel (required)
Body Parameter — get balance

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

getSupply

post /platform/api/v1/bcflow/onchain/external/DeFi/ft/getSupply

Get total Supply. (platformApiV1BcflowOnchainExternalDeFiFtGetSupplyPost)
Enables getting total supply.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetSupplyModel models.GetSupplyModel (required)
Body Parameter — get supply

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

getCollectionId

post /platform/api/v1/bcflow/onchain/external/DeFi/nft/getCollectionId

Get collection Id. (platformApiV1BcflowOnchainExternalDeFiNftGetCollectionIdPost)
Enables getting collection Id.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetCollectionIDModel models.GetCollectionIDModel (required)
Body Parameter — get collectionId

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

getCollectionLength

post /platform/api/v1/bcflow/onchain/external/DeFi/nft/getCollectionLength

Get collection Length. (platformApiV1BcflowOnchainExternalDeFiNftGetCollectionLengthPost)
Enables getting the size/length of collection.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetCollectionLengthModel models.GetCollectionLengthModel (required)
Body Parameter — get collectionLength

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

getNFTItemByTypeID

post /platform/api/v1/bcflow/onchain/external/DeFi/nft/getNFTItemByTypeID

Get NFT item based on Collection id. (platformApiV1BcflowOnchainExternalDeFiNftGetNFTItemByTypeIDPost)
Enables getting NFT item based on collection id.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetKittyItemTypeIDModel models.GetKittyItemTypeIDModel (required)
Body Parameter — get nftItemByTypeID

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

buyMarketItem

post /platform/api/v1/bcflow/onchain/external/DeFi/marketplace/buyMarketItem

Buy Market Item. (platformApiV1BcflowOnchainExternalDeFiMarketplaceBuyMarketItemPost)
Enables buying NFT item from marketplace.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.BuyMarketItemModel models.BuyMarketItemModel (required)
Body Parameter — buy marketItem

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

sellMarketItem

post /platform/api/v1/bcflow/onchain/external/DeFi/marketplace/sellMarketItem

Sell Market Item. (platformApiV1BcflowOnchainExternalDeFiMarketplaceSellMarketItemPost)
Enables selling/listing NFT item into marketplace.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.SellMarketItemModel models.SellMarketItemModel (required)
Body Parameter — sell marketItem

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

RemoveMarketItem

post /platform/api/v1/bcflow/onchain/external/DeFi/marketplace/RemoveMarketItem

Unlist Market Item. (platformApiV1BcflowOnchainExternalDeFiMarketplaceRemoveMarketItemPost)
Enables unlisting NFT item from marketplace.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.RemoveMarketItemModel models.RemoveMarketItemModel (required)
Body Parameter — sell marketItem

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

mintFT

post /platform/api/v1/bcflow/onchain/external/DeFi/ft/mintFT

Mint Fungible Token. (platformApiV1BcflowOnchainExternalDeFiFtMintFTPost)
Enables minting of Fungible Token and depositing into recepient account. Amount to be minted is passed through argurment.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.MintFTModel models.MintFTModel (required)
Body Parameter — mint FT

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

transferFT

post /platform/api/v1/bcflow/onchain/external/DeFi/ft/transferFT

Transfer Fungible Token. (platformApiV1BcflowOnchainExternalDeFiFtTransferFTPost)
Enables transfer of Fungible Token and subsquently credit/debit into accounts.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.TransferFTModel models.TransferFTModel (required)
Body Parameter — transfer FT

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

mintNFT

post /platform/api/v1/bcflow/onchain/external/DeFi/nft/mintNFT

Mint Non-fungible Token. (platformApiV1BcflowOnchainExternalDeFiNftMintNFTPost)
Enables minting of Non-Fungible Token and Depositing into recepient account. Item to be minted is passed through argurment.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.MintNFTModel models.MintNFTModel (required)
Body Parameter — mint NFT

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

transferNFT

post /platform/api/v1/bcflow/onchain/external/DeFi/nft/transferNFT

Transfer Non-Fungible Token. (platformApiV1BcflowOnchainExternalDeFiNftTransferNFTPost)
Enables transfer of Non-Fungible Token and subsquently credit/debit into accounts.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.TransferNFTModel models.TransferNFTModel (required)
Body Parameter — transfer NFT

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

PlatformDeFiParityAPIs

createnetwork

post /platform/api/v1/runtimes/onchain/internal/DeFi/createnetwork

Launch a parity blockchain network (platformApiV1RuntimesOnchainInternalDeFiCreatenetworkPost)
Launch a parity blockchain network using custom chain specification

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

networkName string (required)
Body Parameter — create parity blockchain network

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

deploynetwork

post /platform/api/v1/runtimes/onchain/internal/DeFi/deploynetwork

Launch a parity blockchain network based on a custom specification (platformApiV1RuntimesOnchainInternalDeFiDeploynetworkPost)
Deploy custom chain specification

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

networkName string (required)
Body Parameter — deploy network

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

generatekey

post /platform/api/v1/runtimes/onchain/internal/DeFi/generatekey

create an account to interact with parity blockchain network (platformApiV1RuntimesOnchainInternalDeFiGeneratekeyPost)
It provides a mechanism to generate an account and interact with Parity.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GenerateKeyModel models.GenerateKeyModel (required)
Body Parameter — create key

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

insertkey

post /platform/api/v1/runtimes/onchain/internal/DeFi/insertkey

It provides mechanism to add key (platformApiV1RuntimesOnchainInternalDeFiInsertkeyPost)
It provides a mechanism to add key.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.AuthorRPCKeys models.AuthorRPCKeys (required)
Body Parameter — insert key

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

addnode

post /platform/api/v1/runtimes/onchain/internal/DeFi/addnode

create custom parity chain specification (platformApiV1RuntimesOnchainInternalDeFiAddnodePost)
enables creation one or more blockchain custom private network nodes

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.AddNodeModel models.AddNodeModel (required)
Body Parameter — add node

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

startnode

post /platform/api/v1/runtimes/onchain/internal/DeFi/startnode

Launch parity blockchain peer nodes (platformApiV1RuntimesOnchainInternalDeFiStartnodePost)
start the peer nodes of custom private blockchain network

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.StartNodeModel models.StartNodeModel (required)
Body Parameter — start node

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

PlatformDeFiParityBalancePalletAPIs

setbalance

post /platform/api/v1/bcflow/onchain/internal/DeFi/setbalance

To perform executes SetBalance and sends feedback to the originator. (platformApiV1BcflowOnchainInternalDeFiSetbalancePost)
To perform set balance

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.SetupBalance models.SetupBalance (required)
Body Parameter — set balance

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

balancecheck

post /platform/api/v1/bcflow/onchain/internal/DeFi/balancecheck

To perform balance check and send feedback to the originator. (platformApiV1BcflowOnchainInternalDeFiBalancecheckPost)
To perform balance check

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.FreeBalance models.FreeBalance (required)
Body Parameter — get balance

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

balancetransfer

post /platform/api/v1/bcflow/onchain/internal/DeFi/balancetransfer

To perform executes BalanceTransfer and sends feedback to the originator. (platformApiV1BcflowOnchainInternalDeFiBalancetransferPost)
To perform balance transfer

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.Transfer models.Transfer (required)
Body Parameter — transfer balance

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

getsudouser

post /platform/api/v1/bcflow/onchain/internal/DeFi/getsudouser

To perform executes GetSudoUser and sends feedback to the originator. (platformApiV1BcflowOnchainInternalDeFiGetsudouserPost)
To perform get sudo user

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.GetSudoUser models.GetSudoUser (required)
Body Parameter — get sudo user

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

updatesudouser

post /platform/api/v1/bcflow/onchain/internal/DeFi/updatesudouser

To perform executes UpdateSudoUser and sends feedback to the originator (platformApiV1BcflowOnchainInternalDeFiUpdatesudouserPost)
To perform update sudo user

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

models.SudoUser models.SudoUser (required)
Body Parameter — update sudo user

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

400

Data Models

models.Account –

address (optional)
balance (optional)
clientId (optional)
createTimestamp (optional)
email (optional)
encoded (optional)
genesisHash (optional)
isPseudoUser (optional)
jsonAttr (optional)
mnemonic (optional)
name (optional)
password (optional)
phoneNumber (optional)
publicKey (optional)
requestOperation (optional)
roleDetail (optional)
roleId (optional)
roleName (optional)
updateTimestamp (optional)
userName (optional)

models.AddNodeModel –

auraKey (optional)
chainType (optional)

grandPaKey (optional)

is_bootstrap (optional)
networkName (optional)
nodeName (optional)

models.AmPurchase –

clientId (optional)
clientName (optional)
coin (optional)
createTimestamp (optional)
isApproved (optional)
purchaseId (optional)
reqAmount (optional)
reqCrypto (optional)
requestOperation (optional)
status (optional)
updateTimestamp (optional)

models.ApproveAmPurchase –

purchaseId (optional)
requestOperation (optional)
status (optional)

models.ApproveKyc –

clientId (optional)
requestOperation (optional)
status (optional)

models.ApproveStakeAssetPortfolio –

requestOperation (optional)
stakeRequestId (optional)
status (optional)

models.AuthorRPCKeys –

keyType (optional)
nodeIP (optional)
nodeRPCPort (optional)
publickey (optional)
requestOperation (optional)
secretPhrase (optional)

models.BuyMarketItemModel –

cdcpath (optional)
ftaddress (optional)
kibbleaddress (optional)
kittyitemaddress (optional)
marketplaceaddress (optional)
nftaddress (optional)
privatekey (optional)
requestOperation (optional)
signeraddress (optional)
typeid (optional)

models.CreateAccountModel –

gasLimit (optional)
hashAlgoName (optional)
privateKeyHex (optional)
publicKeyHex (optional)
requestOperation (optional)
serviceAddressHex (optional)
servicePrivKeyHex (optional)
serviceSigAlgoHex (optional)
sigAlgoName (optional)

models.CreateKeyModel –

requestOperation (optional)
seed (optional)
seedalgo (optional)

models.EventLog –

ceDeFiTicker (optional)
chainTicker (optional)
clientId (optional)
event (optional)
eventSource (optional)
eventTransaction (optional)
process (optional)
time (optional)
txnId (optional)

models.Events –

ceDeFiTicker (optional)
chainTicker (optional)
clientId (optional)
event (optional)
eventSource (optional)
eventTransaction (optional)
process (optional)
time (optional)
txnId (optional)

models.FreeBalance –

accAddress (optional)
accPublicKey (optional)
accURI (optional)
requestOperation (optional)
url (optional)

models.GenerateKeyModel –

mneumonic (optional)
networkName (optional)
scheme (optional)

models.GetAccount –

clientId (optional)
requestOperation (optional)
userName (optional)

models.GetAmPurchase –

clientId (optional)
purchaseId (optional)
requestOperation (optional)

models.GetBalanceModel –

cdcpath (optional)
ftaddress (optional)
kibbleaddress (optional)
requestOperation (optional)
signeraddress (optional)

models.GetCollectionIDModel –

cdcpath (optional)
kittyitemaddress (optional)
marketplaceaddress (optional)
nftaddress (optional)
requestOperation (optional)
signeraddress (optional)

models.GetCollectionLengthModel –

cdcpath (optional)
kittyitemaddress (optional)
nftaddress (optional)
requestOperation (optional)
signeraddress (optional)

models.GetEthBlockInput –

HydratedTransactions (optional)
blockNumber (optional)
hashBlock (optional)
method (optional)
nodeIP (optional)

models.GetEthClientInput –

method (optional)
nodeIP (optional)
type (optional)

models.GetKittyItemTypeIDModel –

cdcpath (optional)
itemid (optional)
kittyitemaddress (optional)
nftaddress (optional)
requestOperation (optional)
signeraddress (optional)

models.GetKyc –

clientId (optional)
requestOperation (optional)

models.GetStakeAssetPortfolio –

clientId (optional)
requestOperation (optional)

models.GetStakeMeta –

requestOperation (optional)

models.GetSudoUser –

requestOperation (optional)
url (optional)

models.GetSupplyModel –

cdcpath (optional)
ftaddress (optional)
kibbleaddress (optional)
requestOperation (optional)
signeraddress (optional)

models.Kyc –

clientId (optional)
createTimestamp (optional)
isApproved (optional)
kycDataId (optional)
name (optional)
nationality (optional)
passportExpiryDate (optional)
passportNumber (optional)
requestOperation (optional)
status (optional)
updateTimestamp (optional)

models.MintFTModel –

cdcpath (optional)
ftaddress (optional)
kibbleaddress (optional)
privatekey (optional)
recepientaddress (optional)
requestOperation (optional)
signeraddress (optional)
tokenamount (optional)

models.MintNFTModel –

cdcpath (optional)
kittyitemaddress (optional)
nftaddress (optional)
privatekey (optional)
recepientaddress (optional)
requestOperation (optional)
signeraddress (optional)
typeid (optional)

models.RemoveMarketItemModel –

cdcpath (optional)
marketplaceaddress (optional)
privatekey (optional)
requestOperation (optional)
signeraddress (optional)
typeid (optional)

models.SellMarketItemModel –

cdcpath (optional)
ftaddress (optional)
kibbleaddress (optional)
kittyitemaddress (optional)
marketplaceaddress (optional)
nftaddress (optional)
price (optional)
privatekey (optional)
requestOperation (optional)
signeraddress (optional)
typeid (optional)

models.Sender –

accAddress (optional)
accPublicKey (optional)
accURI (optional)
amount (optional)

models.SetUpAccountModel –

cdcpath (optional)
ftaddress (optional)
kibbleaddress (optional)
kittyitemaddress (optional)
marketplaceaddress (optional)
nftaddress (optional)
privatekey (optional)
requestOperation (optional)
signeraddress (optional)

models.SetupBalance –

clientID (optional)
newFree (optional)
newReserved (optional)
requestOperation (optional)
sudoAccAddress (optional)
sudoAccPublicKey (optional)
sudoAccURI (optional)
url (optional)
whoAccount (optional)

models.StakeAssetPortfolio –

amount (optional)
clientId (optional)
createTimestamp (optional)
crypto (optional)
days (optional)
endDate (optional)
estApy (optional)
isApprove (optional)
isSuccess (optional)
maxLockToken (optional)
minLockToken (optional)
oper (optional)
percentage (optional)
period (optional)
requestOperation (optional)
stakeRequestId (optional)
status (optional)
subDate (optional)
token (optional)
updateTimestamp (optional)
yieldAmount (optional)

models.StakeMeta –

createTimestamp (optional)
days (optional)
maxLockToken (optional)
minLockToken (optional)
percentageApy (optional)
requestOperation (optional)
stakeMetaId (optional)
stakeType (optional)
token (optional)
updateTimestamp (optional)

models.StartNodeModel –

BootnodeId (optional)
isBootStrapNode (optional)
networkName (optional)
nodeName (optional)
nodePort (optional)
rpcPort (optional)
wsPort (optional)

models.SudoUser –

newSudopublicKey (optional)
oldSudoAddress (optional)
oldSudoKey (optional)
oldSudoURI (optional)
requestOperation (optional)
url (optional)

models.TransactionOption –

clientId (optional)
clientUrl (optional)
contractAddress (optional)
gasLimit (optional)
privateKey (optional)
round (optional)
value (optional)

models.Transfer –

palette (optional)
requestOperation (optional)
sender (optional)
toHexAccountID (optional)
url (optional)

models.TransferFTModel –

cdcpath (optional)
ftaddress (optional)
kibbleaddress (optional)
privatekey (optional)
recepientaddress (optional)
requestOperation (optional)
signeraddress (optional)
tokenamount (optional)

models.TransferNFTModel –

cdcpath (optional)
kittyitemaddress (optional)
nftaddress (optional)
privatekey (optional)
recepientaddress (optional)
requestOperation (optional)
signeraddress (optional)
typeid (optional)

models.GetEthBlockInput –

HydratedTransactions (optional)
blockNumber (optional)
hashBlock (optional)
method (optional)
nodeIP (optional)

models.GetEthClientInput –

method (optional)
nodeIP (optional)
type (optional)

models.GetEthExecuteInput –

method (optional)
nodeIP (optional)
transaction (optional)
type (optional)

models.GetEthFeeMarketInput –

blockCount (optional)
method (optional)
newestBlock (optional)
nodeIP (optional)
rewardPercentiles (optional)

models.GetEthFilterInput –

filterIdentifier (optional)
filterIdentifiers (optional)
method (optional)
nodeIP (optional)
topics (optional)

models.GetEthMiningInput –

difficulty (optional)
hashrate (optional)
id (optional)
method (optional)
nodeIP (optional)
prooofOfWorkHash (optional)
seedHash (optional)

models.GetEthSignInput –

address (optional)
message (optional)
method (optional)
nodeIP (optional)
transaction (optional)

models.GetEthStateInput –

address (optional)
method (optional)
nodeIP (optional)
storageposition (optional)
type (optional)

models.GetEthSubmitInput –

method (optional)
nodeIP (optional)
signedTransactionData (optional)
transactions (optional)

models.GetEthTransactionInput –

blockHash (optional)
blockNumber (optional)
method (optional)
nodeIP (optional)
transactionHash (optional)
transactionIndex (optional)

models.GetKsqlInput –

ksql (optional)
method (optional)
nodeIP (optional)
streamsProperties (optional)

models.Identifier –

filterIdentifiers (optional)

models.Option –

method (optional)
reply (optional)
replyTag (optional)
replyTx (optional)
topic (optional)
url (optional)

models.Options –

options (optional)

models.Publish –

data (optional)

models.trans –

data (optional)
from (optional)
gas (optional)
gasPrice (optional)
to (optional)
value (optional)

models.transaction –

data (optional)
from (optional)
gas (optional)
gasPrice (optional)
to (optional)
value (optional)

models.transactions –

data (optional)
from (optional)
gas (optional)
gasPrice (optional)
to (optional)
value (optional)