action dodo_get_nh_sea {
  label: "All New Horizons sea creatures"
  description: "Get a list of all sea creatures and their details in *Animal Crossing: New Horizons*."
  provider: dodo
  method: GET
  path: "/nh/sea"
  encoding: json
  input: {
    type: "object"
    properties: {
      "Accept-Version": {
        type: "string"
      }
      "X-API-KEY": {
        type: "string"
        format: "uuid"
      }
      excludedetails: {
        type: "string"
      }
      month: {
        type: "string"
      }
      thumbsize: {
        type: "integer"
      }
    }
    required: ["Accept-Version", "X-API-KEY"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      properties: {
        catchphrases: {
          type: "array"
          description: "An array of possible catchphrases the player says after catching the sea creature. Most critters have just one, but some can have multiple."
          items: {
            type: "string"
          }
        }
        image_url: {
          type: "string"
          description: "Image of the sea creature. dodo.ac is Nookipedia's CDN server."
        }
        name: {
          type: "string"
          description: "Name of the sea creature."
        }
        north: {
          type: "object"
          description: "When you can catch the sea creature in the Northern hemisphere."
          properties: {
            availability_array: {
              type: "array"
              description: "An array of objects, each object holding a months string and the time the critter is availabile during the specified month(s) in the northern hemisphere. Most critters will have just one object. A small number of critters have variable time availability in which case this array will have multiple objects."
              items: {
                type: "object"
                properties: {
                  months: {
                    type: "string"
                  }
                  time: {
                    type: "string"
                  }
                }
              }
            }
            months: {
              type: "string"
              description: "The months the sea creature is available for in the Northern hemisphere. If all year, value will be `\"All year\"`."
            }
            months_array: {
              type: "array"
              description: "An array of integers representing the months the sea creature is available in the Northern hemisphere."
              items: {
                type: "integer"
              }
            }
            times_by_month: {
              type: "object"
              description: "An object with twelve numerical keys, each representing a month (`\"1\"` for January, `\"2\"` for February, etc.). The value is the times the critter is available during that month. If the critter is unavailable in a month, the value will be `\"NA\"`."
              properties: {
                "1": {
                  type: "string"
                }
                "2": {
                  type: "string"
                }
                "3": {
                  type: "string"
                }
                "4": {
                  type: "string"
                }
                "5": {
                  type: "string"
                }
                "6": {
                  type: "string"
                }
                "7": {
                  type: "string"
                }
                "8": {
                  type: "string"
                }
                "9": {
                  type: "string"
                }
                "10": {
                  type: "string"
                }
                "11": {
                  type: "string"
                }
                "12": {
                  type: "string"
                }
              }
            }
          }
        }
        number: {
          type: "integer"
          description: "In-game sea creature number, marking position in the Critterpedia."
        }
        rarity: {
          type: "string"
          description: "How rare the sea creature is. Note that this field is currently empty for most sea creatures as we do not yet know how exactly sea creature rarities are calculated in the game code."
        }
        render_url: {
          type: "string"
          description: "Render of the sea creature. dodo.ac is Nookipedia's CDN server."
        }
        sell_nook: {
          type: "integer"
          description: "The number of Bells the sea creature can be sold to Nook's store for."
        }
        shadow_movement: {
          type: "string"
          description: "Short descriptor of where the sea creature can be found."
          enum: ["Stationary", "Very slow", "Slow", "Medium", "Fast", "Very fast"]
        }
        shadow_size: {
          type: "string"
          description: "Short descriptor of where the sea creature can be found."
          enum: ["X-Small", "Small", "Medium", "Large", "X-Large"]
        }
        south: {
          type: "object"
          description: "When you can catch the sea creature in the Southern hemisphere."
          properties: {
            availability_array: {
              type: "array"
              description: "An array of objects, each object holding a months string and the time the critter is availabile during the specified month(s) in the southern hemisphere. Most critters will have just one object. A small number of critters have variable time availability in which case this array will have multiple objects."
              items: {
                type: "object"
                properties: {
                  months: {
                    type: "string"
                  }
                  time: {
                    type: "string"
                  }
                }
              }
            }
            months: {
              type: "string"
              description: "The months the sea creature is available for in the Southern hemisphere. If all year, value will be `\"All year\"`."
            }
            months_array: {
              type: "array"
              description: "An array of integers representing the months the sea creature is available in the Southern hemisphere."
              items: {
                type: "integer"
              }
            }
            times_by_month: {
              type: "object"
              description: "An object with twelve numerical keys, each representing a month (`\"1\"` for January, `\"2\"` for February, etc.). The value is the times the critter is available during that month. If the critter is unavailable in a month, the value will be `\"NA\"`."
              properties: {
                "1": {
                  type: "string"
                }
                "2": {
                  type: "string"
                }
                "3": {
                  type: "string"
                }
                "4": {
                  type: "string"
                }
                "5": {
                  type: "string"
                }
                "6": {
                  type: "string"
                }
                "7": {
                  type: "string"
                }
                "8": {
                  type: "string"
                }
                "9": {
                  type: "string"
                }
                "10": {
                  type: "string"
                }
                "11": {
                  type: "string"
                }
                "12": {
                  type: "string"
                }
              }
            }
          }
        }
        tank_length: {
          type: "number"
          format: "float"
          description: "The length of the tank when the sea creature is placed as a furniture item."
        }
        tank_width: {
          type: "number"
          format: "float"
          description: "The width of the tank when the sea creature is placed as a furniture item."
        }
        total_catch: {
          type: "integer"
          description: "The total number of sea creatures the player has to have caught before this sea creature will start spawning."
        }
        url: {
          type: "string"
          description: "Link to the respective Nookipedia article."
        }
      }
    }
  }
}