Aquabyte

Aquabyte Welfare API

Welfare APIs

GitHub OpenAPI
Business capability
Aquaculture Operations Management BC-3520

Operations 2

GET /welfareScores Welfare scores for one or more pens #
POST /superiorRate (Experimental API) Superior rate for a pen. #

Documentation

📖
Documentation
https://api.aquabyte.ai/v3/docs
📖
APIReference
https://api.aquabyte.ai/v3/docs
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/authentication/aquabyte-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/rate-limits/aquabyte-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/openapi/aquabyte-welfare-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/conventions/aquabyte-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/errors/aquabyte-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/data-model/aquabyte-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/lifecycle/aquabyte-lifecycle.yml
🔗
Deprecation
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/lifecycle/aquabyte-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/conformance/aquabyte-conformance.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/aquabyte/refs/heads/main/agentic-access/aquabyte-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aquabyte-welfare-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aquabyte-welfare-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aquabyte API Documentation Welfare API
  description: '# Aquabyte Public API


    To use our API you must be issued an API key.'
  version: v3.1
servers:
- url: /v3
- url: https://api.aquabyte.ai/v3
  description: Aquabyte API Server
tags:
- name: welfare
  description: Welfare APIs
paths:
  /welfareScores:
    get:
      tags:
      - welfare
      summary: Welfare scores for one or more pens
      operationId: get_pen_welfare_data_welfareScores_get
      parameters:
      - name: penId
        in: query
        required: true
        schema:
          type: string
          description: penId to query. Use "all" to query all pens
        description: penId to query. Use "all" to query all pens
      - name: fromDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: from date. Default is 7 days before toDate
        description: from date. Default is 7 days before toDate
      - name: toDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: to date (inclusive). Default is today
        description: to date (inclusive). Default is today
      - name: nextToken
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: (optional) token to fetch the next batch of result
        description: (optional) token to fetch the next batch of result
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aqua_api__paginator__append_next_token___locals___Wrapped__6'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /superiorRate:
    post:
      tags:
      - welfare
      summary: (Experimental API) Superior rate for a pen.
      operationId: get_pen_superior_rate_superiorRate_post
      parameters:
      - name: penId
        in: query
        required: true
        schema:
          type: string
      - name: fromDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: from date. Default is 7 days before toDate
        description: from date. Default is 7 days before toDate
      - name: toDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: to date (inclusive). Default is today
        description: to date (inclusive). Default is today
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DowngradeRuleset'
              description: Downgrade ruleset to apply
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperiorRateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DowngradeScores:
      properties:
        score1:
          type: number
          description: Downgrade score for score 1
          default: 0.0
        score2:
          type: number
          description: Downgrade score for score 2
          default: 0.0
        score3:
          type: number
          description: Downgrade score for score 3
          default: 0.0
      type: object
      title: DowngradeScores
    aqua_api__paginator__append_next_token___locals___Wrapped__6:
      properties:
        welfareScores:
          items:
            $ref: '#/components/schemas/WelfareScoresRecord'
          type: array
          description: List of welfare scores records
        nextToken:
          anyOf:
          - type: string
          - type: 'null'
          description: If this is null, the result set is complete. If not null, fetch the next batch of result by passing this token to the next request.
      type: object
      required:
      - welfareScores
      title: Wrapped
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input: {}
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
      title: HTTPValidationError
    WelfareScoresDetail:
      properties:
        bodyWound:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        scaleLoss:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        snoutWound:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        maturation:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        eyeBleeding:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        eyeClouding:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        exophthalmos:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        opercularDamage:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        backDeformity:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        pelvicFin:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        pectoralFin:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        caudalFin:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        analFin:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        dorsalFin:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        upperJawDeformity:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        lowerJawDeformity:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
        mechHeadWound:
          anyOf:
          - $ref: '#/components/schemas/WelfareScoreDetail'
          - type: 'null'
      type: object
      title: WelfareScoresDetail
    WelfareScoreDetail:
      properties:
        active:
          $ref: '#/components/schemas/WelfareScoreProportions'
          description: Proportions of active welfare scores
        nothing:
          type: number
          description: Proportion of healthy fish
        sampleSize:
          type: number
          description: Number of samples used to calculate scores
        healed:
          $ref: '#/components/schemas/WelfareScoreProportions'
          description: Proportions of healed welfare scores
      type: object
      required:
      - active
      - nothing
      - sampleSize
      title: WelfareScoreDetail
    DowngradeScoresSubcategory:
      properties:
        active:
          $ref: '#/components/schemas/DowngradeScores'
          description: Downgrade scores for active wounds
        healed:
          $ref: '#/components/schemas/DowngradeScores'
          description: Downgrade scores for healed wounds
      type: object
      title: DowngradeScoresSubcategory
    DowngradeRuleset:
      properties:
        bodyWound:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScoresSubcategory'
          - type: 'null'
          description: Downgrade rules for body wounds
        scaleLoss:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for scale loss
        snoutWound:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for snout wounds
        maturation:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for maturation
        eyeBleeding:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for eye bleeding
        eyeClouding:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for eye clouding
        exophthalmos:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for exophthalmos
        opercularDamage:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for opercular damage
        backDeformity:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for back deformity
        pelvicFin:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for pelvic fin
        pectoralFin:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for pectoral fin
        caudalFin:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for caudal fin
        analFin:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for anal fin
        dorsalFin:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for dorsal fin
        upperJawDeformity:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for upper_jaw_deformity
        lowerJawDeformity:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for lower_jaw_deformity
        breathingMouth:
          anyOf:
          - $ref: '#/components/schemas/DowngradeScores'
          - type: 'null'
          description: Downgrade rules for breathing_mouth
      additionalProperties: false
      type: object
      title: DowngradeRuleset
    SuperiorRateRecord:
      properties:
        penId:
          type: string
          description: Pen identifier
        date:
          type: string
          format: date
          description: Date of the superior rate record
        superiorRate:
          type: number
          description: Superior rate value for the pen on the given date
        dataQuality:
          anyOf:
          - $ref: '#/components/schemas/DataQualityEnum'
          - type: 'null'
          description: Data quality for the day
      type: object
      required:
      - penId
      - date
      - superiorRate
      - dataQuality
      title: SuperiorRateRecord
    WelfareScoresRecord:
      properties:
        penId:
          type: string
          description: Pen identifier
        date:
          type: string
          format: date
          description: Date of the welfare scores
        welfareScores:
          $ref: '#/components/schemas/WelfareScoresDetail'
          description: Welfare scores for the day
      type: object
      required:
      - penId
      - date
      - welfareScores
      title: WelfareScoresRecord
    SuperiorRateResponse:
      properties:
        superiorRate:
          items:
            $ref: '#/components/schemas/SuperiorRateRecord'
          type: array
          description: List of superior rate records
      type: object
      required:
      - superiorRate
      title: SuperiorRateResponse
    WelfareScoreProportions:
      properties:
        '1':
          type: number
          description: Proportion of fish with score 1
        '2':
          type: number
          description: Proportion of fish with score 2
        '3':
          type: number
          description: Proportion of fish with score 3
      type: object
      required:
      - '1'
      - '2'
      - '3'
      title: WelfareScoreProportions
    DataQualityEnum:
      type: string
      enum:
      - high
      - medium
      - low
      - ''
      title: DataQualityEnum