FalconryScale
DevelopersAPI reference

Search raptor species

Finds species by part of their common or scientific name, with typical weight ranges in grams. Use it to get the `speciesId` that create_raptor and update_raptor need.

GET
/species

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.

Query Parameters

query*string

Part of a common or scientific name, e.g. "harris" or "Falco".

Length2 <= length <= 100
limit?integer

Max results. Default 10, max 50.

Range0 < value <= 50

Response Body

Search raptor species

application/json
  1. response
species*array<>
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/species?query=string'
Example Response
{
  "species": [
    {
      "id": "string",
      "commonName": "string",
      "scientificName": "string",
      "family": "string",
      "typicalWeightMinGrams": 0,
      "typicalWeightMaxGrams": 0,
      "femaleWeightMinGrams": 0,
      "femaleWeightMaxGrams": 0,
      "maleWeightMinGrams": 0,
      "maleWeightMaxGrams": 0
    }
  ]
}

Update a raptor's details

Edits a raptor's details. Only the fields you send change: omit a field to keep it, send null to clear it. Needs edit rights on the bird (its owner, or a team admin). Photos can't be changed through the API.

List a raptor’s past moults

Returns a raptor's finished moults, most recent first, with start/end dates (ISO 8601) and end weight in grams.