Search
Search companies and authors
High-level entity search across Yellowbrick. q matches author username and display name, and company ticker, legal name, and alternate names. It does not search pitch text. Take authors[].username and companies[].companyId and pass them to GET /api/v1/pitches.
GET
/
api
/
v1
/
search
Search companies and authors
curl --request GET \
--url https://www.joinyellowbrick.com/api/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.joinyellowbrick.com/api/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.joinyellowbrick.com/api/v1/search', 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://www.joinyellowbrick.com/api/v1/search",
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://www.joinyellowbrick.com/api/v1/search"
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))
}HttpResponse<String> response = Unirest.get("https://www.joinyellowbrick.com/api/v1/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.joinyellowbrick.com/api/v1/search")
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{
"authors": [
{
"userId": "<string>",
"username": "<string>",
"displayName": "<string>",
"profileImageUri": "<string>",
"tier": "<string>"
}
],
"companies": [
{
"companyId": 0,
"tradingItemId": 0,
"companyName": "<string>",
"ticker": "<string>",
"exchangeSymbol": "<string>",
"exchangeCountryIso2": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}Authorizations
Key from Profile. Send Authorization: Bearer yb_....
Query Parameters
Optional. Vercel Protection Bypass for Automation — use when calling the Staging server.
At least 2 characters. Matches authors by username or display name, and companies by ticker, legal name, or alternate name. Use the returned username and companyId on GET /api/v1/pitches.
Minimum string length:
2Maximum results across both lists. About three quarters go to companies; the rest go to authors. Default 16, maximum 30.
Required range:
x <= 30⌘I
Search companies and authors
curl --request GET \
--url https://www.joinyellowbrick.com/api/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.joinyellowbrick.com/api/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.joinyellowbrick.com/api/v1/search', 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://www.joinyellowbrick.com/api/v1/search",
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://www.joinyellowbrick.com/api/v1/search"
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))
}HttpResponse<String> response = Unirest.get("https://www.joinyellowbrick.com/api/v1/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.joinyellowbrick.com/api/v1/search")
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{
"authors": [
{
"userId": "<string>",
"username": "<string>",
"displayName": "<string>",
"profileImageUri": "<string>",
"tier": "<string>"
}
],
"companies": [
{
"companyId": 0,
"tradingItemId": 0,
"companyName": "<string>",
"ticker": "<string>",
"exchangeSymbol": "<string>",
"exchangeCountryIso2": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}