Filterable market screener

GET

api

cli

scan

Filterable market screener

curl --request GET \
  --url https://api.shumi.ai/api/cli/scan \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.shumi.ai/api/cli/scan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shumi.ai/api/cli/scan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.shumi.ai/api/cli/scan"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.shumi.ai/api/cli/scan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "schemaVersion": 1,
  "data": "<unknown>",
  "meta": {
    "ts": "2023-11-07T05:31:56Z",
    "as_of": "2023-11-07T05:31:56Z",
    "data_age_seconds": 123
  }
}

{
  "schemaVersion": 1,
  "error": {
    "code": "BAD_REQUEST",
    "message": "action=movements requires ?contract=<token address>"
  }
}

{
  "x402Version": 1,
  "accepts": [
    {
      "scheme": "exact",
      "network": "base",
      "maxAmountRequired": "5000",
      "resource": "https://api.shumi.ai/api/cli/coin/risk/DOGE",
      "payTo": "0x...",
      "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "maxTimeoutSeconds": 60,
      "extra": {
        "name": "USD Coin",
        "version": "2"
      }
    }
  ]
}

{
  "schemaVersion": 1,
  "error": {
    "code": "AUTH_REQUIRED",
    "message": "Authentication required. Run: shumi login"
  }
}

{
  "schemaVersion": 1,
  "error": {
    "code": "RATE_LIMITED",
    "message": "Quota exceeded (50/50 on access); resets at 00:00 UTC, or upgrade to Pro for unlimited"
  }
}

Authorizations

Authorization

string

header

required

An API key (shumi_sk_…) or a session JWT. Create a key with shumi login and shumi keys create.

Query Parameters

trend

enum<string>

Available options:

UP,

HODL,

DOWN

Response

Success.

Success envelope. schemaVersion only changes on a breaking shape change, so a pinned client can detect one.

schemaVersion

integer

required

Example:

1

data

any

required

Route-specific payload.

meta

object

required

Show child attributes

Filterable market screener

curl --request GET \
  --url https://api.shumi.ai/api/cli/scan \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.shumi.ai/api/cli/scan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shumi.ai/api/cli/scan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.shumi.ai/api/cli/scan"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.shumi.ai/api/cli/scan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "schemaVersion": 1,
  "data": "<unknown>",
  "meta": {
    "ts": "2023-11-07T05:31:56Z",
    "as_of": "2023-11-07T05:31:56Z",
    "data_age_seconds": 123
  }
}

{
  "schemaVersion": 1,
  "error": {
    "code": "BAD_REQUEST",
    "message": "action=movements requires ?contract=<token address>"
  }
}

{
  "x402Version": 1,
  "accepts": [
    {
      "scheme": "exact",
      "network": "base",
      "maxAmountRequired": "5000",
      "resource": "https://api.shumi.ai/api/cli/coin/risk/DOGE",
      "payTo": "0x...",
      "asset": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "maxTimeoutSeconds": 60,
      "extra": {
        "name": "USD Coin",
        "version": "2"
      }
    }
  ]
}

{
  "schemaVersion": 1,
  "error": {
    "code": "AUTH_REQUIRED",
    "message": "Authentication required. Run: shumi login"
  }
}

{
  "schemaVersion": 1,
  "error": {
    "code": "RATE_LIMITED",
    "message": "Quota exceeded (50/50 on access); resets at 00:00 UTC, or upgrade to Pro for unlimited"
  }
}