Carbon

Documentation

Welcome to Carbon's docs!

Get Started    

API Reference

No frills, instantaneous price feed. Price is aggregated across all possible exchanges for a given trading pair. Also includes a menu of available trading pairs.

Example implementation at beta.katechon.world

Endpoint

Authentication

To access the API, specify an "api_secret" in the Headers

For security, the quotes endpoint is protected. For the time being, please email [email protected] to get your api_secret.

headers: {
    'api_secret': API_SECRET
}

Endpoints

Home : Useful to test connectivity and displays menu of available methods

Route: "/"

let params = {
}

let method = "/"
let url = ENDPOINT+method

// Call API...

let response = {
    "message": "Welcome to the Katechon Capital Markets API!"
}

Get a Quote : Get price for a given base-quote market

Route: "/quotes"

let params = {
  base: 'EMT',
  quote: 'CUSD
}

let method = "/quotes"
let url = ENDPOINT+method

// Call API...

let response = {
  "price": 0.022900252140108494,
  "base": "EMT",
  "quote": "CUSD"
}

Get all Markets: Display all available markets that we can query quotes for

Route: "/markets"

let params = {
}

let method = "/markets"
let url = ENDPOINT+method

// Call API...

let response = {
    "ANTE": [
        "TRX",
        "USDT"
    ],
    "BNB": [
        "CUSD",
        "ETH"
    ],
    "BTC": [
        "CUSD"
    ],
    "BTT": [
        "TRX",
        "USDT"
    ],
    "CUSD": [
        "EOS",
        "ETH"
    ],
    "DAI": [
        "USDC"
    ],
    "EMT": [
        "BTC",
        "CUSD",
        "EOS"
    ],
    "EOS": [
        "CUSD",
        "USDT"
    ],
    "ETH": [
        "BTC",
        "CUSD"
    ],
    "FXC": [
        "BTC",
        "CUSD",
        "ETH"
    ],
    "GRIN": [
        "USDT"
    ],
    "IQ": [
        "CUSD",
        "EOS"
    ],
    "KARMA": [
        "CUSD",
        "EOS"
    ],
    "LUME": [
        "CUSD",
        "EOS"
    ],
    "PIXEOS": [
        "CUSD",
        "EOS"
    ],
    "SEED": [
        "CUSD",
        "EOS"
    ],
    "TLOS": [
        "CUSD",
        "EOS"
    ],
    "TRX": [
        "USDT"
    ],
    "USD": [
        "USDT"
    ],
    "WETH": [
        "CUSD"
    ]
}

Node.js

// Example of getting EOS-CUSD quote:

let base_token_param = "EOS"
let quote_token_param = "CUSD"
let api_secret = API_SECRET
fetch(`https://carbon-market-maker.herokuapp.com/api/quotes?base=${base_token_param}&quote=${quote_token_param}`, {
        method: 'GET'
        headers: {
            'api_secret': API_SECRET
        },
 }
)
.then(response => response.json())
.then(json => {
  if (json.price) {
    console.log(`Price: ${json.price}`)
  }
})

API Reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.