openapi-directory/api/dodo.ac.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.nookipedia.com/"}],"info":{"description":"The Nookipedia API provides endpoints for retrieving *Animal Crossing* data pulled from the [Nookipedia wiki](https://nookipedia.com/wiki/Main_Page). A couple of the key benefits of using the Nookipedia API is access to data spanning the entire *Animal Crossing* series, as well as information that is constantly updated and expanding as editors work on the wiki.<br><br>Access to the Nookipedia API requires obtaining a key. This is so we can manage our scale and provide better support for our users. To request access to the API, please fill out [this form](https://forms.gle/wLwtXLerKhfDrRLY8).","title":"Nookipedia","version":"1.6.0","x-origin":[{"format":"openapi","url":"https://api.nookipedia.com/static/doc.yaml","version":"3.0"}],"x-providerName":"dodo.ac"},"paths":{"/nh/art":{"get":{"description":"Get a list of all artwork and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"When set to `true`, only artwork that has a fake will be returned. When set to `false`, only artwork without fakes will be returned.","in":"query","name":"hasfake","required":false,"schema":{"type":"string"}},{"description":"When set to `true`, only artwork names are returned. Instead of an array of objects with all details, the return will be an array of strings.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL. Note that requesting specific image sizes for long lists may result in a very long response time.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHArtwork"},"type":"array"}}},"description":"A JSON array of artwork."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons artwork"}},"/nh/art/{artwork}":{"get":{"description":"Retrieve information about a specific artwork in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the artwork you wish to retrieve information about.","in":"path","name":"artwork","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHArtwork"}}},"description":"A JSON object describing the artwork."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons artwork"}},"/nh/bugs":{"get":{"description":"Get a list of all bugs and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Retrive only the bug that are available in a specific month. Value may be the month's name (`jan`, `january`), the integer representing the month (`01`, `1`), or `current` for the current month. When `current` is specified, the return body will be an object with two arrays inside, one called `north` and the other `south` containing the bug available in each respective hemisphere. Note that the current month is calculated based off the API server's time, so it may be slightly off for you at the beginning or end of the month.","in":"query","name":"month","required":false,"schema":{"type":"string"}},{"description":"When set to `true`, only bug names are returned. Instead of an array of objects with all details, the return will be an array of strings. This is particularly useful when used with the `month` filter, for users who want just a list of bugs in a given month but not all their respective details.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL. Note that requesting specific image sizes for long lists may result in a very long response time.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHBug"},"type":"array"}}},"description":"A JSON array of bugs."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons bugs"}},"/nh/bugs/{bug}":{"get":{"description":"Retrieve information about a specific bug in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the bug you wish to retrieve information about.","in":"path","name":"bug","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHBug"}}},"description":"A JSON object describing the bug."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404"}}},"description":"Could not find the specified bug."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons bug"}},"/nh/clothing":{"get":{"description":"Get a list of all clothing items and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the category of clothing to return.","in":"query","name":"category","required":false,"schema":{"enum":["Tops","Bottoms","Dress-up","Headwear","Accessories","Socks","Shoes","Bags","Umbrellas"],"type":"string"}},{"description":"Return clothing that matches the provided colors (may specify one or two colors). Colors are used for gifting villagers.","in":"query","name":"color","required":false,"schema":{"items":{"enum":["Aqua","Beige","Black","Blue","Brown","Colorful","Gray","Green","Orange","Pink","Purple","Red","White","Yellow"],"type":"string"},"type":"array"}},{"description":"Return clothing that matches the provided styles (may specify one or two styles). Styles are used for gifting villagers.","in":"query","name":"style","required":false,"schema":{"items":{"enum":["Active","Cool","Cute","Elegant","Gorgeous","Simple"],"type":"string"},"type":"array"}},{"description":"Return clothing that have the specified Label theme. This is used for completing the requested outfit theme for [Label](https://nookipedia.com/wiki/Label) when she visits the player's island.","in":"query","name":"labeltheme","required":false,"schema":{"enum":["Comfy","Everyday","Fairy tale","Formal","Goth","Outdoorsy","Party","Sporty","Theatrical","Vacation","Work"],"type":"string"}},{"description":"When set to `true`, only clothing names are returned. Instead of an array of objects with all details, the return will be an array of strings.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHClothing"},"type":"array"}}},"description":"A JSON array of clothing."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons clothing"}},"/nh/clothing/{clothing}":{"get":{"description":"Retrieve information about a specific clothing item in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the clothing you wish to retrieve information about.","in":"path","name":"clothing","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHClothing"}}},"description":"A JSON object describing the clothing."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons clothing"}},"/nh/events":{"get":{"description":"Get a list of events and dates in *Animal Crossing: New Horizons*, filterable to specific years, months, or days. Data is available for the current and next year.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify a specific date (in the current or next year) to retrieve events for. Accepts many date formats, such as `YYYY-MM-DD` or `Month Day, Year`, as well as `today` to retrieve the current day's events (UTC time).","in":"query","name":"date","required":false,"schema":{"type":"string"}},{"description":"Specify the year to retrieve events for. Must be the current or next year.","in":"query","name":"year","required":false,"schema":{"type":"string"}},{"description":"Specify the month to retrieve events for (accepts multiple formats, such as `Oct`, `October`, or `10`). Most likely want to use alongside `year`, otherwise events in both the current and next year are returned.","in":"query","name":"month","required":false,"schema":{"type":"string"}},{"description":"Specify the day of the month to retrieve events for.","in":"query","name":"day","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHEvent"},"type":"array"}}},"description":"A JSON array of events."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons events"}},"/nh/fish":{"get":{"description":"Get a list of all fish and their details in *New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Retrive only the fish that are available in a specific month. Value may be the month's name (`jan`, `january`), the integer representing the month (`01`, `1`), or `current` for the current month. When `current` is specified, the return body will be an object with two arrays inside, one called `north` and the other `south` containing the fish available in each respective hemisphere. Note that the current month is calculated based off the API server's time, so it may be slightly off for you at the beginning or end of the month.","in":"query","name":"month","required":false,"schema":{"type":"string"}},{"description":"When set to `true`, only fish names are returned. Instead of an array of objects with all details, the return will be an array of strings. This is particularly useful when used with the `month` filter, for users who want just a list of fish in a given month but not all their respective details.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL. Note that requesting specific image sizes for long lists may result in a very long response time.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHFish"},"type":"array"}}},"description":"A JSON array of fish."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons fish"}},"/nh/fish/{fish}":{"get":{"description":"Retrieve information about a specific fish in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the fish you wish to retrieve information about.","in":"path","name":"fish","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHFish"}}},"description":"A JSON object describing the fish."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404"}}},"description":"Could not find the specified fish."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons fish"}},"/nh/fossils/all":{"get":{"description":"Get a list of all the fossil groups with their respective individual fossils in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHFossilGroupWithIndividualFossilsNoMatched"},"type":"array"}}},"description":"A JSON array of fossil groups."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons fossil groups or individual fossil"}},"/nh/fossils/all/{fossil}":{"get":{"description":"Retrieve information about a specific fossil group with their respective individual fossils in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the fossil OR fossil group you wish to retrieve information about. If a fossil is provided, a fossil group that the specified fossil belongs to will be returned.","in":"path","name":"fossil","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHFossilGroupWithIndividualFossils"}}},"description":"A JSON object describing the fossil group."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons fossil group with individual fossils"}},"/nh/fossils/groups":{"get":{"description":"Get a list of all the fossil groups in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHFossilGroup"},"type":"array"}}},"description":"A JSON array of fossil groups."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons fossil groups"}},"/nh/fossils/groups/{fossil_group}":{"get":{"description":"Retrieve information about a specific fossil group in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the fossil group you wish to retrieve information about.","in":"path","name":"fossil_group","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHFossilGroup"}}},"description":"A JSON object describing the fossil group."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons fossil group"}},"/nh/fossils/individuals":{"get":{"description":"Get a list of all the individual fossils in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHIndividualFossil"},"type":"array"}}},"description":"A JSON array of individual fossils."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons fossils"}},"/nh/fossils/individuals/{fossil}":{"get":{"description":"Retrieve information about a specific individual fossil in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the individual fossil you wish to retrieve fossil information about.","in":"path","name":"fossil","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHIndividualFossil"}}},"description":"A JSON object describing the individual fossil."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons fossil"}},"/nh/furniture":{"get":{"description":"Get a list of all furniture and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the category of furniture to return (houswares, miscellaneous, or wall-mounted).","in":"query","name":"category","required":false,"schema":{"enum":["Housewares","Miscellaneous","Wall-mounted"],"type":"string"}},{"description":"Return furniture that matches the provided colors (may specify one or two colors).","in":"query","name":"color","required":false,"schema":{"items":{"enum":["Aqua","Beige","Black","Blue","Brown","Colorful","Gray","Green","Orange","Pink","Purple","Red","White","Yellow"],"type":"string"},"type":"array"}},{"description":"When set to `true`, only furniture names are returned. Instead of an array of objects with all details, the return will be an array of strings.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHFurniture"},"type":"array"}}},"description":"A JSON array of furniture."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons furniture"}},"/nh/furniture/{furniture}":{"get":{"description":"Retrieve information about a specific furniture in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the furniture you wish to retrieve information about.","in":"path","name":"furniture","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHFurniture"}}},"description":"A JSON object describing the furniture."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons furniture"}},"/nh/interior":{"get":{"description":"Get a list of all interior items (flooring, wallpaper, and rugs) and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Return furniture that matches the provided colors (may specify one or two colors).","in":"query","name":"color","required":false,"schema":{"items":{"enum":["Aqua","Beige","Black","Blue","Brown","Colorful","Gray","Green","Orange","Pink","Purple","Red","White","Yellow"],"type":"string"},"type":"array"}},{"description":"When set to `true`, only interior item names are returned. Instead of an array of objects with all details, the return will be an array of strings.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHInterior"},"type":"array"}}},"description":"A JSON array of interior items."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons interior items"}},"/nh/interior/{item}":{"get":{"description":"Retrieve information about a specific interior item in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the interior item you wish to retrieve information about.","in":"path","name":"item","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Return furniture that matches the provided colors (may specify one or two colors).","in":"query","name":"color","required":false,"schema":{"items":{"enum":["Aqua","Beige","Black","Blue","Brown","Colorful","Gray","Green","Orange","Pink","Purple","Red","White","Yellow"],"type":"string"},"type":"array"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHInterior"}}},"description":"A JSON object describing the interior item."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons interior item"}},"/nh/items":{"get":{"description":"Get a list of all miscellaneous items (such as materials, star fragments, fruits, fences, and plants) and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"When set to `true`, only item names are returned. Instead of an array of objects with all details, the return will be an array of strings.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHItem"},"type":"array"}}},"description":"A JSON array of items."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Miscellaneous New Horizons items"}},"/nh/items/{item}":{"get":{"description":"Retrieve information about a miscellaneous item (such as materials, star fragments, fruits, fences, and plants) in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the interior item you wish to retrieve information about.","in":"path","name":"item","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHItem"}}},"description":"A JSON object describing the item."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons miscellaneous item"}},"/nh/photos":{"get":{"description":"Get a list of all character photos+posters and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"When set to `true`, only item names are returned. Instead of an array of objects with all details, the return will be an array of strings.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHPhoto"},"type":"array"}}},"description":"A JSON array of photos and posters."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons photos and posters"}},"/nh/photos/{item}":{"get":{"description":"Retrieve information about a character photo or poster in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the photo or poster you wish to retrieve information about.","in":"path","name":"item","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHPhoto"}}},"description":"A JSON object describing the photo or poster."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons photo or poster"}},"/nh/recipes":{"get":{"description":"Get a list of all recipes and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify a material to only get recipes that use that material. You can specify `material` up to six times (no recipe uses more than six materials).","in":"query","name":"material","required":false,"schema":{"type":"string"}},{"description":"When set to `true`, only recipe names are returned. Instead of an array of objects with all details, the return will be an array of strings.","in":"query","name":"excludedetails","required":false,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL. Note that requesting specific image sizes for long lists may result in a very long response time.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NHRecipe"},"type":"array"}}},"description":"A JSON array of recipes."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"All New Horizons recipes"}},"/nh/recipes/{item}":{"get":{"description":"Retrieve information about a specific recipe in *Animal Crossing: New Horizons*.","parameters":[{"description":"The name of the item you wish to retrieve recipe information about.","in":"path","name":"item","required":true,"schema":{"type":"string"}},{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not actually enforced by the API. If you do not specify a version, you will be served the latest version, which may eventually result in breaking changes.","in":"header","name":"Accept-Version","required":true,"schema":{"type":"string"}},{"description":"Specify the desired width of returned image URLs. When unspecified, the linked image(s) returned by the API will be full-resolution. Note that images can only be reduced in size; specifying a width greater than than the maximum size will return the default full-size image URL.","in":"query","name":"thumbsize","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NHRecipe"}}},"description":"A JSON object describing the recipe."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}},"description":"Failed to authenticate user from `X-API-KEY`."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500"}}},"description":"There was an error fetching the requested data."}},"summary":"Single New Horizons recipe"}},"/nh/sea":{"get":{"description":"Get a list of all sea creatures and their details in *Animal Crossing: New Horizons*.","parameters":[{"description":"Your UUID secret key, granted to you by the Nookipedia team. Required for accessing the API.","in":"header","name":"X-API-KEY","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The version of the API you are calling, written as `1.0.0`. This is specified as required as good practice, but it is not