DataBolsa docs
Referência da APIPlataformaFunctions

Catálogo de Functions

Lista as Functions do contrato como descritores curtos: id, título, critério de uso, sujeito, scopes e a rota de execução. `query` casa com id, título, descrição e critério; `subject_kind` recorta às que aceitam um tipo de objeto. O spec completo, com schemas, está em `getFunction`.

GET
/v1/functions

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

query?string

Texto livre sobre id, título, descrição e critério.

domain?string

Recorta ao domínio (o primeiro segmento do id): market, funds, credit, documents, events, macro, us, bonds, commodities, minerals.

subject_kind?string

Só funções que aceitam este tipo de objeto.

subject_mode?string

object só as que exigem objeto do grafo; resource só as que exigem recurso de módulo; none só as globais.

Value in"object" | "resource" | "none"
limit?integer

Candidatos a devolver (1–100, default 50).

Default50
Range1 <= value <= 100

Response Body

curl -X GET "https://api.databolsa.com/v1/functions?query=string&domain=string&subject_kind=string&subject_mode=object&limit=50"
{
  "data": [
    {
      "id": "string",
      "type": "primitive",
      "module": "string",
      "domain": "string",
      "title": "string",
      "description": "string",
      "criterio": "string",
      "subject": {
        "mode": "object",
        "kinds": [
          "company"
        ],
        "subkinds": [
          "string"
        ],
        "grain": "object"
      },
      "lifecycle": "default",
      "stability": "stable",
      "scopes": [
        "string"
      ],
      "confirmation": "required",
      "execute": {
        "method": "GET",
        "path": "string"
      },
      "describe": "string",
      "legacy_operation": "string"
    }
  ],
  "meta": {
    "next_cursor": null,
    "count": 0,
    "total": 0,
    "hint": "string"
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "details": {
    "property1": null,
    "property2": null
  }
}

Spec de uma Function

O contrato executável de uma Function: sujeito aceito, `input_schema`, `output_schema`, forma temporal e corte, paginação, autoridade, estabilidade, host e o binding legado enquanto existir.

Spec de uma capacidade

O contrato executável de UMA capacidade pelo id qualificado, de qualquer módulo instalado: Function (`input_schema`, `output_schema`, sujeito, `example`), Action (confirmação, idempotência, efeitos) ou primitiva (parâmetros e resposta da operação). Ache o id em `listCapabilities` e chame isto só para a escolhida.