Skip to main content
GET
/
v1
/
entities
/
:id
/
references
Get Entity References
curl --request GET \
  --url https://api.shoal.xyz/v1/entities/:id/references \
  --header 'Authorization: Bearer <token>'
Returns external references attached to one canonical Shoal entity. This route is part of the canonical entity contract. The dedicated ExternalReference storage layer is live, but responses may still be sparse until source population and backfill expand coverage.

​
Path Parameters

  • id (integer, required)

​
Request

cURL
curl -X GET "https://api.shoal.xyz/v1/entities/23151/references" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response (200)

{
  "entity": {
    "id": 23151,
    "canonicalName": "Ethereum",
    "displayName": "Ethereum",
    "entityType": "project",
    "status": "active",
    "aliases": ["Ethereum Foundation", "ETH"],
    "references": []
  },
  "data": []
}

​
Notes

  • This route establishes the entity-attached reference contract.
  • The storage layer is live; sparse results now mean the entity has not been enriched yet.
  • Over time, this surface is intended to include sources like CoinGecko, DefiLlama, CoinMarketCap, official websites, and GitHub.

​
Errors

  • 400 if id is missing
  • 404 if the entity does not exist
  • 500 on internal server error