Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zest Contracts API

Read-only access to the spaas-contract registry (templates, catalogs, primitives, samples) used to validate SPV-request `attributes`.

Zest Contracts API is one of 8 APIs that Zest publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contracts. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a getting-started guide.

This API exposes 9 operations across 9 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://sandbox-api.zestequity.com.

9 operations 9 paths 2 schemas 9 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://public-api.zestequity.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zest Contracts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.

Contracts 9

Read-only access to the spaas-contract registry (templates, catalogs, primitives, samples) used to validate SPV-request attributes.

GET
/v1/contracts
List available contract versions
list_contract_versions_v1_contracts_get → 200
GET
/v1/contracts/templates/{version}
List template definitions for a version
list_templates_v1_contracts_templates__version__get 1 param → 200422
GET
/v1/contracts/templates/{version}/{template_name}
Retrieve a specific template
get_template_v1_contracts_templates__version___template_name__get 2 params → 200422
GET
/v1/contracts/catalogs/{version}
List attribute catalogs for a version
list_catalogs_v1_contracts_catalogs__version__get 1 param → 200422
GET
/v1/contracts/catalogs/{version}/{catalog_name}
Retrieve a specific attribute catalog
get_catalog_v1_contracts_catalogs__version___catalog_name__get 2 params → 200422
GET
/v1/contracts/primitives/{version}
List primitive/type specifications for a version
list_primitives_v1_contracts_primitives__version__get 1 param → 200422
GET
/v1/contracts/primitives/{version}/{primitive_name}
Retrieve a primitive/type definition
get_primitive_v1_contracts_primitives__version___primitive_name__get 2 params → 200422
GET
/v1/contracts/samples/{version}
List sample payloads for a version
list_samples_v1_contracts_samples__version__get 1 param → 200422
GET
/v1/contracts/samples/{version}/{sample_name}
Retrieve a sample payload
get_sample_v1_contracts_samples__version___sample_name__get 2 params → 200422

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ValidationError (3 properties), HTTPValidationError (1 property). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zest-contracts-api-openapi.yml Raw ↑

Other APIs Zest publishes across the network.

Zest Authentication API
Zest Investors API
Zest SPV Requests API
Zest Subscription Forms API
Zest Subscription Fundings API
Zest Subscriptions API
Zest System API