Provider Gateway Examples

These examples show the lower-level gateway route shape for provider-backed reads. Prefer capability routes or route planning for repeated product workflows. Use provider gateway routes when you are inspecting adapter behavior, debugging a provider-specific path, or validating a new capability mapping.

Boundary

Clients send only a PubFi API key.
Upstream provider credentials stay server-side.
Provider inclusion in Discovery does not imply gateway availability.
Gateway examples are route-shape examples, not public pricing, uptime, ranking, or citation proof.

Auth

Authorization: Bearer <PubFi API key>
X-PubFi-Api-Key: <PubFi API key>

Route Shape

https://api.pubfi.ai/v1/gateway/{provider}/{network}/{endpoint...}

The {provider} and {network} segments are provider-specific gateway routing inputs. The {endpoint...} segment maps to the upstream path supported by the adapter. The examples below are public route-shape examples and certified readiness examples where noted. They are not a promise that every OpenAPI-listed provider path is certified or path-complete.

Subscan Gateway Example

Subscan examples use the network segment to select the upstream chain host, such as polkadot or acala. Example routes:

GET /v1/gateway/subscan/polkadot/api/now
POST /v1/gateway/subscan/polkadot/api/v2/scan/accounts
POST /v1/gateway/subscan/polkadot/api/scan/account/tokens
POST /v1/gateway/subscan/acala/api/scan/account/tokens

Example request:

curl --location 'https://api.pubfi.ai/v1/gateway/subscan/polkadot/api/now' \
  --header 'Authorization: Bearer <PubFi API key>'

For a runnable Subscan inspection script, see the Subscan gateway example.

DeGov Gateway Example

DeGov uses a fixed upstream base URL, so PubFi uses global as the gateway network placeholder. Example routes:

GET /v1/gateway/degov/global/health
GET /v1/gateway/degov/global/v1/meta/pricing
GET /v1/gateway/degov/global/v1/daos
GET /v1/gateway/degov/global/v1/activity
GET /v1/gateway/degov/global/v1/system/freshness
GET /v1/gateway/degov/global/v1/daos/{daoId}/brief
GET /v1/gateway/degov/global/v1/items/{kind}/{externalId}

Example free route:

curl --location 'https://api.pubfi.ai/v1/gateway/degov/global/v1/daos' \
  --header 'Authorization: Bearer <PubFi API key>'

Example DAO brief route:

curl --location 'https://api.pubfi.ai/v1/gateway/degov/global/v1/daos/ring-dao/brief' \
  --header 'Authorization: Bearer <PubFi API key>'

Generated Generic Gateway Boundary

Generated generic adapters are limited to crypto/Web3/on-chain data operations. They become public runtime routes only after the exact operation appears in the current certified gateway catalog. An empty catalog is a valid fail-closed state. Discovery inclusion, prior certification, or an old route-shape example does not establish current availability. Current public examples preserve route shape and response families, but they intentionally avoid publishing real account data, real keys, or upstream provider credentials.

Gateway Response Shape

Successful gateway responses use a PubFi envelope around the provider payload:

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<request id>",
    "provider": "degov",
    "network": "global",
    "route": "/v1/gateway/degov/global/v1/daos",
    "upstream": {
      "status": 200
    }
  }
}

The data value is the provider JSON payload returned for the routed endpoint, so its nested shape differs by provider and route. The exact payload and upstream metadata belong to the provider endpoint. Use the interactive API reference and current route readiness before treating a route as executable in production.

Common Gateway Outcomes

HTTP status	Code	When it happens
`200`	`ok: true`	Gateway authenticated the request and the upstream provider returned success.
`401`	`pubfi.unauthorized`	No PubFi API key was sent, or the key is invalid, revoked, or inactive.
`402`	`gateway.insufficient_credits`	Current billing admission has insufficient request allocation.
`403`	`pubfi.forbidden`	The API key is valid but does not include the scope required for provider invocation.
`502`	`pubfi.gateway_failed`	Route decision, provider dispatch, or upstream gateway execution failed.
`503`	`pubfi.provider_credentials_not_configured`	The provider route needs a server-side credential that is not configured.
`503`	`pubfi.provider_credentials_unavailable`	Provider credentials are temporarily unavailable.

What This Page Does Not Publish

Real PubFi API keys.
Upstream provider keys.
Server-side credential administration details.
Account ids, usage rows, or billing records.
A claim that every listed provider route is always callable.
A claim that a gateway route is a stable public capability when a PubFi capability exists.

Start

Getting Started

Concepts

Agent-Readable

Use Cases

Reference

Project

Provider Gateway Examples

Provider Gateway Examples

Boundary

Auth

Route Shape

Subscan Gateway Example

DeGov Gateway Example

Generated Generic Gateway Boundary

Gateway Response Shape

Common Gateway Outcomes

What This Page Does Not Publish

​Provider Gateway Examples

​Boundary

​Auth

​Route Shape

​Subscan Gateway Example

​DeGov Gateway Example

​Generated Generic Gateway Boundary

​Gateway Response Shape

​Common Gateway Outcomes

​What This Page Does Not Publish

Provider Gateway Examples

Boundary

Auth

Route Shape

Subscan Gateway Example

DeGov Gateway Example

Generated Generic Gateway Boundary

Gateway Response Shape

Common Gateway Outcomes

What This Page Does Not Publish