{ "openapi": "3.0.0", "info": { "title": "AntCheck API Documentation", "description": "Welcome to the AntCheck API!
\n Here are some basic guidelines to help you use our API effectively and responsibly:
\n
\n Respect our terms of use: By using our API, you agree to comply with our terms of use. These terms are designed to ensure that our service is used in a fair and responsible manner.
\n License: CC BY-NC 4.0
\n
\n - Use our API for non-commercial purposes: Our API is not intended for commercial use without prior permission. If you are interested in using our API for commercial purposes, please contact us to discuss licensing options and fees.
\n - Provide attribution: If you use our API in your project or application, please provide attribution by including e.g. our logo, a link to our website or the name Antcheck.info.
\n - Fair use: If the usage load is too high, we reserve the right to restrict api access
\n
\n

\n We hope that these guidelines help you use our API effectively and responsibly. If you have any questions or concerns, please don't hesitate to reach out to us at https://antcheck.info/contact\n ", "version": "1.0.0" }, "servers": [ { "url": "/api", "description": "Official AntCheck API v1" } ], "paths": { "/ant-avatar/generate/{seed}": { "get": { "tags": [ "Test (Please ignore this)" ], "summary": "generate ant avatar", "operationId": "generate_ant_avatar", "parameters": [ { "name": "seed", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Image" } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ] } }, "/antcheck/offers_nested": { "get": { "tags": [ "AntCheck" ], "summary": "AntCheck Offers (nested data structure)", "description": "Get all the ant species that are currently being sold with a nested data structure including variants, shops and species. Ideal for integrating into an application showing all the offers for certain ant species. This format is for example used by the antcheck discord bot.", "operationId": "antcheck_offers_nested", "parameters": [ { "name": "genus", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "species", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name_as_key", "in": "query", "description": "Use names for the array keys instead of IDs. Default: false.", "required": false, "schema": { "type": "boolean" } }, { "name": "price_as", "in": "query", "description": "Convert the price to a specific currency. Leave blank to use the shops currency. Format: Currency ISO. Options: (USD,EUR,GBP,...,..). For all options check out the /misc/currency API)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Nested json containing shops, species and variants." } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ] } }, "/antcheck/species": { "get": { "tags": [ "AntCheck" ], "summary": "Get ant species", "description": "Get all or specific ant species. Option to show only species at least sold once.", "operationId": "antcheck_species", "parameters": [ { "name": "genus", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "species", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "soldatleastonce", "in": "query", "description": "Only show species that were sold at least once.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Array of species.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Species" } } } } } } }, "/antcheck/shops": { "get": { "tags": [ "AntCheck" ], "summary": "Get ant shops", "description": "Get all or specific ant shops.

Explaination 'active_listed': True if this shops products are activly listed and updated on AntCheck.", "operationId": "antcheck_shops", "parameters": [ { "name": "shopid", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "shopname", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of shops.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shop" } } } } } } }, "/antcheck/offers": { "get": { "tags": [ "AntCheck" ], "summary": "Get shop variants / offers", "description": "Get all or specific offers / variants from ant shops.", "operationId": "antcheck_offers", "parameters": [ { "name": "shopid", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "speciesid", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "price_as", "in": "query", "description": "Convert the price to a specific currency. Leave blank to use the shops currency. Format: Currency ISO. Options: (USD,EUR,GBP,...,..). For all options check out the /misc/currency API)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of variants.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Variant" } } } } } } }, "/antweb/images": { "get": { "tags": [ "AntWeb" ], "summary": "Get specimen identification images from AntWeb.org.", "description": "Typically, there are 4 image types: h(head), p(side), d(top), l(info). This api response time is a little bit slower, therefore the output will be cached for 3 months.", "operationId": "antweb_images", "parameters": [ { "name": "genus", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "species", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Nested json containing links to images" } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ], "x-cache_time": "3 months" } }, "/antweb/image/{specimen_code}/{shot}_{number}": { "get": { "tags": [ "AntWeb" ], "summary": "Get info about a specific specimen identification image from AntWeb.org.", "description": "Typically, there are 4 image types: h(head), p(side), d(top), l(info). This api response time is a little bit slower, therefore the output will be cached for 3 months.", "operationId": "antweb_image", "parameters": [ { "name": "specimen_code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "shot", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "number", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Nested json containing links to images" } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ], "x-cache_time": "0 second" } }, "/misc/countries": { "get": { "tags": [ "Misc" ], "summary": "Get a list of the worlds countries.", "description": "Get a list of the worlds countries.", "operationId": "misc_countries", "parameters": [ { "name": "iso", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Json containing list of countries." } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ] } }, "/misc/sites": { "get": { "tags": [ "Misc" ], "summary": "Get a list of ant related websites, shops excluded.", "description": "Get a list of ant related websites, shops excluded.", "operationId": "misc_sites", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Json containing list of websites." } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ] } }, "/misc/currency": { "get": { "tags": [ "Misc" ], "summary": "Get a list of currencies with the euro conversion rate.", "description": "Get a list of currencies with the euro conversion rate. Source: European central bank - https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml", "operationId": "misc_currency", "parameters": [ { "name": "iso", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Json containing list of currencies" } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ] } }, "/test": { "get": { "tags": [ "Test (Please ignore this)" ], "summary": "Test", "operationId": "test", "responses": { "200": { "description": "Test" } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ] } }, "/species/list/{id}/{test}": { "get": { "tags": [ "Test (Please ignore this)" ], "summary": "List all users", "operationId": "species_list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "test", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "An array of users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Species" } } } } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ] } }, "/species/flights": { "get": { "tags": [ "Test (Please ignore this)" ], "summary": "List all flights", "operationId": "flights_list", "responses": { "200": { "description": "Test" } }, "security": [ { "apiKeyHeaderAuth": [] }, { "apiKeyQueryAuth": [] } ], "x-cache_time": "3 months" } } }, "components": { "schemas": { "Species": { "required": [ "id", "species", "genus" ], "properties": { "id": { "type": "integer", "example": 1 }, "genus": { "type": "string", "example": "Lasius" }, "species": { "type": "string", "example": "niger" }, "image_url": { "type": "string", "example": "https://antcheck.info/include/frontend/img/compressed/large/ants/Lasius_flavus.jpeg" }, "image_caption": { "type": "string", "example": "Lasius flavus nuptial flight in Germany" }, "image_licence": { "type": "string", "example": "Darvin" }, "url": { "type": "string", "example": "https://antcheck.info/species/Lasius_flavus" } }, "type": "object" }, "Shop": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "example": 0 }, "name": { "type": "string", "example": "AntCheck" }, "url": { "type": "string", "example": "https://antcheck.info/" }, "shipping": { "type": "string", "example": "" }, "country": { "type": "string", "example": "de" }, "currency": { "type": "string", "example": "EUR" }, "active_listed": { "type": "boolean", "example": 0 }, "last_update": { "type": "string", "example": "2023-04-16 06:06:02" }, "discount": { "type": "array", "items": { "properties": { "available": { "type": "boolean" }, "code": { "type": "string" }, "condition": { "type": "string" } }, "type": "object" }, "example": { "available": false, "code": "10%_ON_ALL", "condition": "Demo discount. Not valid." } } }, "type": "object" }, "Variant": { "required": [ "id", "shopid", "speciesid", "name", "price", "url" ], "properties": { "id": { "type": "integer", "example": 0 }, "shopid": { "type": "integer", "example": 0 }, "speciesid": { "type": "integer", "example": 0 }, "name": { "type": "string", "example": "1 Queen + 10-20 workers" }, "price": { "type": "number", "format": "float", "example": 123.45 }, "url": { "type": "string", "example": "https://antcheck.info/redirect?id=0" } }, "type": "object" } }, "securitySchemes": { "apiKeyHeaderAuth": { "type": "apiKey", "name": "X-API-KEY", "in": "header" }, "apiKeyQueryAuth": { "type": "apiKey", "name": "api_key", "in": "query" } } } }