Get an integrated provider

curl --request GET \
  --url https://gateway.molpha.io/v1/providers/{providerId}

const options = {method: 'GET'};

fetch('https://gateway.molpha.io/v1/providers/{providerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.molpha.io/v1/providers/{providerId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": "ok",
  "data": {
    "id": "tickerlayer",
    "name": "TickerLayer",
    "description": "<string>",
    "docsUrl": "<string>",
    "termsUrl": "<string>",
    "disclosure": "<string>",
    "aggregation": {
      "mode": "tolerance",
      "minSignatures": 3,
      "reason": "<string>"
    },
    "operations": [
      {
        "id": "crypto.trade_last",
        "assetClass": "crypto",
        "path": "/crypto/trade/last/:symbol",
        "symbolExample": "BTCUSD"
      }
    ],
    "flows": [
      {
        "kind": "x402",
        "baseUrl": "https://x402-testnet.tickerlayer.com",
        "pathPrefix": "/v1",
        "credential": {
          "mode": "sponsored",
          "header": "x-api-key"
        },
        "x402": {
          "scheme": "exact",
          "version": 2,
          "network": "eip155:84532",
          "asset": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
          "assetName": "USDC",
          "paymentModes": [
            "per_node"
          ],
          "catalogUrl": "<string>"
        },
        "feeds": [
          {
            "id": "btcusd",
            "title": "BTC/USD last trade",
            "operation": "crypto.trade_last",
            "symbol": "BTCUSD",
            "sourceId": "<string>",
            "apiConfig": {
              "url": "https://api.example.com/v1/price",
              "method": "GET",
              "headers": {},
              "responseParser": "$.data.price",
              "valueTransform": "multiply:1e6",
              "aggregation": {
                "mode": "tolerance",
                "rule": "median",
                "maxDeviationBps": 50,
                "maxAgeMs": 2000,
                "numeric": {
                  "type": "int256",
                  "decimals": 8
                }
              }
            }
          }
        ]
      }
    ]
  }
}

{
  "error": "provider not found"
}

GET

providers

{providerId}

Get an integrated provider

curl --request GET \
  --url https://gateway.molpha.io/v1/providers/{providerId}

const options = {method: 'GET'};

fetch('https://gateway.molpha.io/v1/providers/{providerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.molpha.io/v1/providers/{providerId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": "ok",
  "data": {
    "id": "tickerlayer",
    "name": "TickerLayer",
    "description": "<string>",
    "docsUrl": "<string>",
    "termsUrl": "<string>",
    "disclosure": "<string>",
    "aggregation": {
      "mode": "tolerance",
      "minSignatures": 3,
      "reason": "<string>"
    },
    "operations": [
      {
        "id": "crypto.trade_last",
        "assetClass": "crypto",
        "path": "/crypto/trade/last/:symbol",
        "symbolExample": "BTCUSD"
      }
    ],
    "flows": [
      {
        "kind": "x402",
        "baseUrl": "https://x402-testnet.tickerlayer.com",
        "pathPrefix": "/v1",
        "credential": {
          "mode": "sponsored",
          "header": "x-api-key"
        },
        "x402": {
          "scheme": "exact",
          "version": 2,
          "network": "eip155:84532",
          "asset": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
          "assetName": "USDC",
          "paymentModes": [
            "per_node"
          ],
          "catalogUrl": "<string>"
        },
        "feeds": [
          {
            "id": "btcusd",
            "title": "BTC/USD last trade",
            "operation": "crypto.trade_last",
            "symbol": "BTCUSD",
            "sourceId": "<string>",
            "apiConfig": {
              "url": "https://api.example.com/v1/price",
              "method": "GET",
              "headers": {},
              "responseParser": "$.data.price",
              "valueTransform": "multiply:1e6",
              "aggregation": {
                "mode": "tolerance",
                "rule": "median",
                "maxDeviationBps": 50,
                "maxAgeMs": 2000,
                "numeric": {
                  "type": "int256",
                  "decimals": 8
                }
              }
            }
          }
        ]
      }
    ]
  }
}

{
  "error": "provider not found"
}

Path Parameters

providerId

string

required

Provider ID, as listed by GET /v1/providers.

Example:

"tickerlayer"

Response

Provider detail

status

string

Example:

"ok"

data

object

Hide child attributes

data.id

string

Example:

"tickerlayer"

data.name

string

Example:

"TickerLayer"

data.description

string

data.docsUrl

string

data.termsUrl

string

The provider's data licence.

data.disclosure

string

How a value from this provider must be described to its users.

data.aggregation

object

The aggregation the provider's feeds require.

Hide child attributes

data.aggregation.mode

string

Example:

"tolerance"

data.aggregation.minSignatures

integer

Example:

3

data.aggregation.reason

string

data.operations

object[]

The provider routes the gateway acts on. Any other route of the provider is an ordinary source and never receives a sponsored credential.

Hide child attributes

data.operations.id

string

Example:

"crypto.trade_last"

data.operations.assetClass

string

Example:

"crypto"

data.operations.path

string

Relative to the flow's baseUrl and pathPrefix; :symbol is its parameter.

Example:

"/crypto/trade/last/:symbol"

data.operations.symbolExample

string

Example:

"BTCUSD"

data.flows

object[]

The access flows the gateway can serve now, each with its own host and feeds.

Hide child attributes

data.flows.kind

enum<string>

Available options:

api_key,

x402

Example:

"x402"

data.flows.baseUrl

string

Example:

"https://x402-testnet.tickerlayer.com"

data.flows.pathPrefix

string

Present only when the flow has one.

Example:

"/v1"

data.flows.credential

object

Set for the api_key flow.

Hide child attributes

data.flows.credential.mode

enum<string>

sponsored: the gateway holds the key and the caller supplies none.

Available options:

sponsored

Example:

"sponsored"

data.flows.credential.header

string

Request header that carries the key.

Example:

"x-api-key"

data.flows.x402

object

Set for the x402 flow.

Hide child attributes

data.flows.x402.scheme

string

Example:

"exact"

data.flows.x402.version

integer

Example:

2

data.flows.x402.network

string

Example:

"eip155:84532"

data.flows.x402.asset

string

Example:

"0x036CbD53842c5426634e7929541eC2318f3dCF7e"

data.flows.x402.assetName

string

Example:

"USDC"

data.flows.x402.paymentModes

enum<string>[]

per_node means one payment per eligible node.

Available options:

per_node

Example:

["per_node"]

data.flows.x402.catalogUrl

string

data.flows.feeds

object[]

Hide child attributes

data.flows.feeds.id

string

Example:

"btcusd"

data.flows.feeds.title

string

Example:

"BTC/USD last trade"

data.flows.feeds.operation

string

Example:

"crypto.trade_last"

data.flows.feeds.symbol

string

Example:

"BTCUSD"

data.flows.feeds.sourceId

string

Hex keccak256 of the canonical apiConfig.

data.flows.feeds.apiConfig

object

Off-chain HTTP API configuration. Its canonical hash is the source ID.

Hide child attributes

data.flows.feeds.apiConfig.url

string

required

Target API URL. Must use http or https.

Example:

"https://api.example.com/v1/price"

data.flows.feeds.apiConfig.method

string

required

HTTP method. Required: GET, POST, PUT, PATCH, DELETE, HEAD or OPTIONS. It is hashed into the source ID as sent.

Example:

"GET"

data.flows.feeds.apiConfig.headers

object

Request headers. Use {{secret.name}} placeholders with encKeyBundle for private APIs.

Hide child attributes

data.flows.feeds.apiConfig.headers.{key}

string

Example:

{}

data.flows.feeds.apiConfig.responseParser

string

JSONPath expression to extract the value from the API response.

Example:

"$.data.price"

data.flows.feeds.apiConfig.valueTransform

string

Optional post-parse transform (e.g. multiply:1e6).

Example:

"multiply:1e6"

data.flows.feeds.apiConfig.aggregation

object

Selects median tolerance mode. Omit it for exact mode. It is part of the source ID; "mode":"exact" is rejected.

Hide child attributes

data.flows.feeds.apiConfig.aggregation.mode

enum<string>

Available options:

tolerance

Example:

"tolerance"

data.flows.feeds.apiConfig.aggregation.rule

enum<string>

Available options:

median

Example:

"median"

data.flows.feeds.apiConfig.aggregation.maxDeviationBps

integer

Largest allowed deviation from the lower median, in basis points.

Example:

50

data.flows.feeds.apiConfig.aggregation.maxAgeMs

integer

Largest allowed age of an observation, in milliseconds. Must be greater than 0.

Required range: x >= 1

Example:

2000

data.flows.feeds.apiConfig.aggregation.numeric

object

How observed decimals become the signed integer.

Hide child attributes

data.flows.feeds.apiConfig.aggregation.numeric.type

enum<string>

Available options:

int256

Example:

"int256"

data.flows.feeds.apiConfig.aggregation.numeric.decimals

integer

The signed value is scaled by 10^decimals.

Example:

8

Gateway API

Rounds

Sign-in sessions

Network

Get an integrated provider

Path Parameters

Response