Get Organization by Name
curl --request GET \
--url https://api.shoal.xyz/v1/organizations/byOrganizationName \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/organizations/byOrganizationName"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/organizations/byOrganizationName', 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.shoal.xyz/v1/organizations/byOrganizationName",
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.shoal.xyz/v1/organizations/byOrganizationName"
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://api.shoal.xyz/v1/organizations/byOrganizationName")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/organizations/byOrganizationName")
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_bodyOrganizations (Compatibility)
Get Organization by Name
Resolve an organization by canonical name or alias
GET
/
v1
/
organizations
/
byOrganizationName
Get Organization by Name
curl --request GET \
--url https://api.shoal.xyz/v1/organizations/byOrganizationName \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/organizations/byOrganizationName"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/organizations/byOrganizationName', 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.shoal.xyz/v1/organizations/byOrganizationName",
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.shoal.xyz/v1/organizations/byOrganizationName"
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://api.shoal.xyz/v1/organizations/byOrganizationName")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/organizations/byOrganizationName")
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_bodyLooks up organizations by name and returns canonical matches. This route remains available for compatibility, but new integrations should prefer
/v1/entities/byName.
Use this when you have a human-readable name like Ethereum or Coinbase and need a stable id for older organization-scoped routes.
Query Parameters
name(string, required)organizationName(string, optional) — Compatibility alias forname
Request
cURL
curl -X GET "https://api.shoal.xyz/v1/organizations/byOrganizationName?name=Ethereum" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
Returns an array of canonical organization matches indata. Search uses case-insensitive partial matching.
{
"data": [
{
"id": 23151,
"label": "Ethereum",
"type": "project",
"aliases": ["Ethereum Foundation", "ETH"],
"matchedVia": "canonical_name",
"matchType": "exact",
"matchRank": 0,
"matchedValue": "Ethereum"
}
]
}
type is the canonical entity type for the matched organization. Current live organization responses use project for protocol-style entities and may expand as more canonical entity types are exposed.
aliases returns a small canonical alias preview so consumers can confirm they selected the correct entity before creating recurring monitoring workflows.
matchedVia, matchType, matchRank, and matchedValue describe why a given canonical entity was returned and how strongly it matched the query. Lower matchRank values are stronger.
For new entity-first workflows, use /v1/entities/byName and then traverse the semantic layer from the returned Shoal entity id.
Errors
- 400 if
namemissing - 500 on internal server error