{ "openapi": "3.1.0", "info": { "title": "Interzoid Standardize Country Data with Info API", "description": "This API uses specialized algorithms, AI models, and extensive knowledge bases to standardize country names and provides additional details such as ISO codes, currency information, internet code, calling code, and other metadata about the country.\nTo use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\nFor more information about this API, visit the [Interzoid Standardize Country Data with Info API Documentation](https://www.interzoid.com/apis/standardize-country-data-info).\n", "version": "1.0.0", "contact": { "name": "Interzoid Support", "url": "https://www.interzoid.com", "email": "support@interzoid.com" } }, "externalDocs": { "description": "API home page and documentation", "url": "https://www.interzoid.com/apis/standardize-country-data-info" }, "servers": [ { "url": "https://api.interzoid.com", "description": "Production server" } ], "tags": [ { "name": "Country Data Standardization with Info", "description": "Standardizes country names and provides additional metadata about the country." } ], "paths": { "/getcountryinfo": { "get": { "tags": [ "Country Data Standardization with Info" ], "summary": "Standardize Country Name and Provide Metadata", "description": "This method uses specialized algorithms, AI models, and extensive knowledge bases to standardize a given country name and provides additional metadata such as ISO codes, currency details, internet code, calling code, and more.\n**Note**: You must include your API key as the `license` parameter in the request. If you do not have an API key, you can register for one at [Interzoid Registration](https://www.interzoid.com/register-api-account).\n", "parameters": [ { "name": "license", "in": "query", "required": true, "description": "Your API license key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\n", "schema": { "type": "string" }, "examples": { "license": { "summary": "API Key Example", "value": "r2d7df664a7c4ef6h8k" } } }, { "name": "country", "in": "query", "required": true, "description": "The country name to be standardized", "schema": { "type": "string" }, "examples": { "country": { "summary": "Country Name Example", "value": "Frankreich" } } }, { "name": "algorithm", "in": "query", "required": true, "description": "The standardization algorithm and AI model used to standardize the country name.", "schema": { "type": "string" }, "examples": { "algorithm": { "summary": "Algorithm Example", "value": "ai-medium" } } } ], "responses": { "200": { "description": "Successful response containing standardized country data and metadata.", "content": { "application/json": { "schema": { "type": "object", "properties": { "CountryStandard": { "type": "string", "description": "The standardized country name." }, "TwoLetterCode": { "type": "string", "description": "ISO 3166-1 alpha-2 code for the country." }, "ThreeLetterCode": { "type": "string", "description": "ISO 3166-1 alpha-3 code for the country." }, "ThreeDigitCode": { "type": "string", "description": "ISO 3166-1 numeric code for the country." }, "CurrencyCode": { "type": "string", "description": "ISO currency code for the country." }, "CurrencyName": { "type": "string", "description": "Name of the country's currency." }, "CurrencySubUnit": { "type": "string", "description": "Subunit of the country's currency (e.g., cents)." }, "CurrencySymbol": { "type": "string", "description": "Symbol for the country's currency." }, "InternetCode": { "type": "string", "description": "Internet domain code for the country." }, "CallingCode": { "type": "string", "description": "International dialing code for the country." }, "Code": { "type": "string", "description": "Execution status message." }, "Credits": { "type": "string", "description": "Remaining credits for your API license." } }, "examples": [ { "summary": "Successful response example", "value": { "CountryStandard": "France", "TwoLetterCode": "FR", "ThreeLetterCode": "FRA", "ThreeDigitCode": "250", "CurrencyCode": "EUR", "CurrencyName": "Euro", "CurrencySubUnit": "cent", "CurrencySymbol": "€", "InternetCode": ".fr", "CallingCode": "+33", "Code": "Success", "Credits": "200402" } } ] } } } }, "400": { "description": "Bad request (e.g., missing or invalid parameters).", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Response code." }, "Message": { "type": "string", "description": "Error message." } }, "examples": [ { "summary": "Missing or invalid parameters", "value": { "Code": 400, "Message": "Invalid license key or country parameter missing." } } ] } } } }, "402": { "description": "API key not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Response code." }, "Message": { "type": "string", "description": "Error message." } }, "examples": [ { "summary": "API key not found", "value": { "Code": 402, "Message": "API key not found." } } ] } } } }, "403": { "description": "Insufficient API credits remaining.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Response code." }, "Message": { "type": "string", "description": "Error message." } }, "examples": [ { "summary": "Insufficient credits", "value": { "Code": 403, "Message": "Insufficient API credits remaining." } } ] } } } }, "405": { "description": "Method not allowed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Response code." }, "Message": { "type": "string", "description": "Error message." } }, "examples": [ { "summary": "Wrong HTTP method", "value": { "Code": 405, "Message": "Method not allowed." } } ] } } } }, "429": { "description": "Rate limits reached.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Response code." }, "Message": { "type": "string", "description": "Error message." } }, "examples": [ { "summary": "Rate limit reached", "value": { "Code": 429, "Message": "Rate limits reached." } } ] } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Response code." }, "Message": { "type": "string", "description": "Error message." } }, "examples": [ { "summary": "Server error", "value": { "Code": 500, "Message": "Internal server error." } } ] } } } } } } } }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "name": "license", "in": "query" } }, "schemas": { "ResponseError": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Response code." }, "Message": { "type": "string", "description": "Error message." } } } } }, "security": [ { "apiKeyAuth": [] } ] }