Skip to main content
All requests require an API key via the X-API-Key header. See Authentication for details.

Overview

GET /v1/streams/points returns the points that belong to the organization associated with the API key. This endpoint is useful when your integration supports point-based streams and needs to list the point assets available for stream creation or reporting. If your organization only creates token-based streams with rewardToken, you do not need to call this endpoint.

Endpoint

curl -X GET "https://earn.turtle.xyz/v1/streams/points?symbol=PTS" \
  -H "X-API-Key: sk_live_xxxxx"
Query Parameters
id
uuid
Optional point identifier.
symbol
string
Optional point symbol filter.
name
string
Optional point name filter.

Response Example

{
  "points": [
    {
      "id": "7ff13cf6-53d0-4f3e-bd1a-e8eab6db4cf1",
      "orgId": "9f51b66a-d13a-4b55-8515-ae6e4ef7cf25",
      "symbol": "PTS",
      "name": "Partner Points",
      "decimals": 18,
      "logoUrl": "https://cdn.example.com/points/pts.png",
      "createdAt": "2026-03-01T00:00:00Z",
      "updatedAt": "2026-03-01T00:00:00Z"
    }
  ]
}

Response Fields

points
Point[]
Array of points owned by the calling organization.
See Create Point for the full Point schema.

Important Notes

This endpoint only returns points belonging to the organization associated with the API key.
Points are used when creating streams that use pointId as the reward source. They are not required for streams that use rewardToken.
You can query by id, symbol, name, or any combination supported by your integration needs.

Error Handling

Status Code: 401 Unauthorized
{
  "error": "Invalid API key"
}
Solution: Pass a valid X-API-Key header belonging to an organization-scoped API key.
Status Code: 500 Internal Server ErrorSolution: Retry the request and contact Turtle if the issue persists.