Skip to main content
API docs by Redocly

Ledger Ops (0.0.59)

Download OpenAPI specification:Download

APIs for performing ledger Operations actions in Marco

Certificates

JWKs Endpoint

This endpoint returns a JSON Web Key Set (JWKS) containing the public keys used to verify the signatures of the tokens.

Authorizations:
ApplicationToken

Responses

Request samples 

curl --request GET \
  --url https://api-marco.finboot.com/v1/ledger-ops/certificates \
  --header 'ApplicationToken: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Ledger Operation Gateway

Contract Call

Allow calling a Smart Contract method for actions requiring ledger consensus.

Authorizations:
ApplicationToken
Request Body schema: application/json
contractId
string
method
string
object (Options)
params
Array of objects

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "method": "string",
  • "options": {
    },
  • "params": [
    ]
}

Response samples

Content type
application/json
{
  • "actionId": "string",
  • "intent": "string",
  • "status": "PENDING"
}

Ledger Call

Allow execute an action on the ledger, for example deploy a smart contract.

Authorizations:
ApplicationToken
Request Body schema: application/json
ledgerId
string
method
string
object (Options)
params
Array of objects

Responses

Request samples

Content type
application/json
{
  • "ledgerId": "string",
  • "method": "string",
  • "options": {
    },
  • "params": [
    ]
}

Response samples

Content type
application/json
{
  • "actionId": "string",
  • "intent": "string",
  • "status": "PENDING"
}

Create send Generic Ledger Operation action

Allow execute ledger operation and query transaction into the ledger and prefetching the needed resources

Authorizations:
ApplicationToken
Request Body schema: application/json
dependencies
Array of strings
glo
object
intent
string or null
tag
string or null
walletId
string
walletPassword
string

Responses

Request samples

Content type
application/json
{
  • "dependencies": [
    ],
  • "glo": { },
  • "intent": "string",
  • "tag": "string",
  • "walletId": "string",
  • "walletPassword": "string"
}

Response samples

Content type
application/json
{
  • "actionId": "string",
  • "intent": "string",
  • "status": "PENDING"
}

Search for actions by its actionIds

Search for actions by its actionIds

Authorizations:
ApplicationToken
Request Body schema: application/json
actionIds
required
Array of strings

An array of action IDs used as search criteria.

Responses

Request samples

Content type
application/json
{
  • "actionIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Search for an action by its actionId

Search for an action by its actionId

Authorizations:
ApplicationToken
path Parameters
actionId
required
string
Example: 0d5081c2-d4c1-4612-958c-606ffd987e26

The ID of the action to retrieve.

Responses

Request samples 

curl --request GET \
  --url https://api-marco.finboot.com/v1/ledger-ops/search/actions/0d5081c2-d4c1-4612-958c-606ffd987e26 \
  --header 'ApplicationToken: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "actionId": "0d5081c2-d4c1-4612-958c-606ffd987e26",
  • "contractAddress": 1.2201460614677089e+48,
  • "dateUpdated": "Fri May 19 15:41:39 UTC 2023",
  • "dependencies": [
    ],
  • "intent": "5ff541af-a2be-49c7-b345-b7ea048b231a",
  • "ledgerId": "finboot-clique-v1",
  • "locator": 1.4979119697907914e+76,
  • "status": "SUCCEEDED",
  • "walletId": "62EPFgDCGOM"
}

Search for actions by its intents

Search for actions by its intents

Authorizations:
ApplicationToken
Request Body schema: application/json
intents
required
Array of strings

An array of intent IDs used as search criteria.

Responses

Request samples

Content type
application/json
{
  • "intents": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Search for an action by its intent

Search for an action by its intent

Authorizations:
ApplicationToken
path Parameters
intent
required
string
Example: 5ff541af-a2be-49c7-b345-b7ea048b231a

The ID of an intent used as search criteria.

Responses

Request samples 

curl --request GET \
  --url https://api-marco.finboot.com/v1/ledger-ops/search/intents/5ff541af-a2be-49c7-b345-b7ea048b231a \
  --header 'ApplicationToken: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Search actions by wallet

Search actions by wallet

Authorizations:
ApplicationToken
path Parameters
walletId
required
string
Example: 62EPFgDCGOM

The ID of the wallet used as search criteria.

Responses

Request samples 

curl --request GET \
  --url https://api-marco.finboot.com/v1/ledger-ops/search/wallets/62EPFgDCGOM/actions \
  --header 'ApplicationToken: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "contentType": "ActionPage"
}