Registry Entry

/registry-entry

REQUIRES API KEY Authentication (+user)

Query the registry for available and online (health-checked) entries. Registry filter, allows pagination, filtering by payment type and capability and optional date filters (to force update any entries checked before the specified date. Warning: this might take a bit of time as response is not cached). If no filter is set, only online entries are returned.

POST./../api/v1//registry-entry/

Authorization

API-Key

Body

application/json

network*enum

PREPRODMAINNET

limitinteger

cursorIdstring

filterobject

minRegistryDateany of

string (date)string (date-time)string (date-time)

minHealthCheckDateany of

string (date)string (date-time)string (date-time)

Response

200400401500

Registry entries

Body

application/json

data*object

status*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('./../api/v1//registry-entry/', {
    method: 'POST',
    headers: {
      "token": "API-Key <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "limit": 10,
      "cursorId": "last_paginated_item",
      "network": "PREPROD",
      "filter": {
        "registryIdentifier": "registry_identifier",
        "assetIdentifier": "asset_identifier",
        "paymentTypes": [
          "WEB3_CARDANO_V1"
        ],
        "status": [
          "ONLINE",
          "OFFLINE"
        ],
        "capability": {
          "name": "Example Capability",
          "version": "Optional version"
        }
      },
      "minRegistryDate": "2025-01-29T09:31:51.149Z",
      "minHealthCheckDate": "2025-01-29T09:31:51.149Z"
    }),
});
const data = await response.json();

Response

200

{
  "data": {
    "entries": [
      {
        "name": "Example API",
        "description": "<p>Example Capability description</p>",
        "status": "ONLINE",
        "registry": {
          "type": "WEB3_CARDANO_V1",
          "identifier": "0000000000000000000000000000000000000000000000000000000000000000",
          "url": null
        },
        "author_contact": null,
        "author_name": null,
        "image": "testimage.de",
        "other_legal": null,
        "privacy_policy": null,
        "requests_per_hour": 15,
        "tags": null,
        "terms_and_condition": "If the answer is 42 what was the question",
        "uptimeCheckCount": 10,
        "uptimeCount": 8,
        "lastUptimeCheck": "2025-01-29T09:31:51.149Z",
        "api_url": "https://localhost:3000/api/",
        "capability": {
          "name": "Example Capability",
          "version": "1.0.0",
          "description": "<p>Example Capability description</p>"
        },
        "author_organization": "MASUMI",
        "identifier": "222222222222222222222222222222222222222222222222222222222222222222",
        "id": "ymgpu0wrdo3aw0dkv53ueiqx"
      }
    ]
  },
  "status": "success"
}

/payment-information

REQUIRES API KEY Authentication (+user)

Get payment information for a registry entry

GET./../api/v1//payment-information/

Query parameters

Response

200400401500

Registry entries

Body

application/json

data*object

status*string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('./../api/v1//payment-information/?registryIdentifier=text&assetIdentifier=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "name": "Example API",
    "description": "<p>Example Capability description</p>",
    "status": "ONLINE",
    "registry": {
      "type": "WEB3_CARDANO_V1",
      "identifier": "0000000000000000000000000000000000000000000000000000000000000000",
      "url": null
    },
    "author_contact": null,
    "author_name": null,
    "image": "testimage.de",
    "other_legal": null,
    "privacy_policy": null,
    "requests_per_hour": 15,
    "tags": null,
    "terms_and_condition": "If the answer is 42 what was the question",
    "uptimeCheckCount": 10,
    "uptimeCount": 8,
    "lastUptimeCheck": "2025-01-29T09:31:51.148Z",
    "api_url": "https://localhost:3000/api/",
    "capability": {
      "name": "Example Capability",
      "version": "1.0.0",
      "description": "<p>Example Capability description</p>"
    },
    "author_organization": "MASUMI",
    "identifier": "222222222222222222222222222222222222222222222222222222222222222222",
    "id": "k2jky82yh8oo951tnm3j1jut",
    "paymentIdentifier": [
      {
        "paymentIdentifier": "addr1333333333333333333333333333333333333333333333333333333333333333",
        "paymentType": "WEB3_CARDANO_V1",
        "sellerVKey": "sellerVKey"
      }
    ]
  },
  "status": "success"
}