Busha Developer Documentation

List stocks

curl --request GET \
  --url https://api.sandbox.busha.so/v1/stocks \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sandbox.busha.so/v1/stocks', 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.sandbox.busha.so/v1/stocks",
  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.sandbox.busha.so/v1/stocks"

	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.sandbox.busha.so/v1/stocks")

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

{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "symbol": "AAPL",
      "name": "Apple",
      "display_ticker": "AAPL",
      "type": "stock",
      "weekend_enabled": true,
      "is_market_open": true,
      "buy_supported": true,
      "sell_supported": true,
      "sector": "<string>",
      "logo_url": "https://example.com",
      "price": {
        "amount": "100",
        "currency": "BTC"
      },
      "change_24h": {
        "currency": "BTC",
        "amount": "100",
        "percent": "100"
      }
    }
  ]
}

GET

stocks

List stocks

curl --request GET \
  --url https://api.sandbox.busha.so/v1/stocks \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sandbox.busha.so/v1/stocks', 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.sandbox.busha.so/v1/stocks",
  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.sandbox.busha.so/v1/stocks"

	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.sandbox.busha.so/v1/stocks")

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

{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "symbol": "AAPL",
      "name": "Apple",
      "display_ticker": "AAPL",
      "type": "stock",
      "weekend_enabled": true,
      "is_market_open": true,
      "buy_supported": true,
      "sell_supported": true,
      "sector": "<string>",
      "logo_url": "https://example.com",
      "price": {
        "amount": "100",
        "currency": "BTC"
      },
      "change_24h": {
        "currency": "BTC",
        "amount": "100",
        "percent": "100"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer Authentication

Headers

X-BU-PROFILE-ID

string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

string

sector

string

type

enum<string>

Available options:

stock,

etf

weekend_enabled

boolean

tradeable

boolean

Filter stocks by whether trading is enabled for the symbol.

following

boolean

Restrict results to the authenticated profile's watchlist. Authed only: an unauthenticated request with following=true returns an empty list rather than an error.

cursor

string<string>

The cursor

sort

enum<string>

The order to sort the results

Available options:

asc,

desc

Example:

"asc"

limit

integer

The number of items to return

Example:

10

Response

A list of stocks.

General response Values

status

enum<string>

required

Available options:

success,

error

Example:

"success"

message

string

required

Example:

"message for success"

pagination

object

required

Show child attributes

data

object[]

required

Show child attributes