{
    "openapi": "3.1.0",
    "info": {
        "title": "API de Geolocalização de IP",
        "version": "v1",
        "description": "Transforme endereços IP em informações geográficas: cidade, país, fuso horário, moeda e provedor, em alemão por padrão."
    },
    "servers": [
        {
            "url": "https://api.flowdata.one/v1",
            "description": "FlowData API"
        }
    ],
    "security": [
        {
            "bearerAuth": []
        }
    ],
    "tags": [
        {
            "name": "single-ip",
            "description": "Consulta de IP único"
        },
        {
            "name": "batch",
            "description": "Consulta em lote"
        }
    ],
    "paths": {
        "/geolocation": {
            "get": {
                "operationId": "geolocation-client",
                "summary": "Consultar o próprio IP",
                "description": "Identifica o endereço IP do cliente que faz a requisição e responde com seus dados de geolocalização. Somente uma resposta com status: success é cobrada.",
                "tags": [
                    "single-ip"
                ],
                "parameters": [
                    {
                        "name": "lang",
                        "in": "query",
                        "required": false,
                        "description": "Idioma dos rótulos geográficos (padrão de, alternativa en)",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Resposta bem-sucedida",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                },
                                "example": {
                                    "status": "success",
                                    "continent": "Nordamerika",
                                    "continentCode": "NA",
                                    "country": "Vereinigte Staaten",
                                    "countryCode": "US",
                                    "region": "CA",
                                    "regionName": "Kalifornien",
                                    "city": "Mountain View",
                                    "district": null,
                                    "zip": "94043",
                                    "lat": 37.4192,
                                    "lon": -122.0574,
                                    "timezone": "America/Los_Angeles",
                                    "offset": -25200,
                                    "currency": "USD",
                                    "isp": "Google LLC",
                                    "org": "Google LLC",
                                    "as": "AS15169 Google LLC",
                                    "asname": "Google LLC",
                                    "reverse": null,
                                    "mobile": null,
                                    "proxy": null,
                                    "hosting": null,
                                    "query": "8.8.8.8"
                                }
                            }
                        }
                    },
                    "default": {
                        "description": "Resposta de erro",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/geolocation/{ip}": {
            "get": {
                "operationId": "geolocation-ip",
                "summary": "Consultar um IP ou domínio específico",
                "description": "Consulta dados de geolocalização de um endereço IPv4, IPv6 ou domínio. Somente uma resposta com status: success é cobrada.",
                "tags": [
                    "single-ip"
                ],
                "parameters": [
                    {
                        "name": "ip",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "IPv4, IPv6 ou domínio, por exemplo 8.8.8.8 ou google.com"
                    },
                    {
                        "name": "lang",
                        "in": "query",
                        "required": false,
                        "description": "Idioma (padrão de)",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Resposta bem-sucedida",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        }
                    },
                    "default": {
                        "description": "Resposta de erro",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/geolocation/batch": {
            "post": {
                "operationId": "geolocation-batch",
                "summary": "Geolocalização em lote",
                "description": "Consulta até 100 endereços IP ou domínios em uma requisição. O corpo da requisição é o próprio array JSON: strings de IP ou objetos no formato {\"query\":\"8.8.8.8\",\"lang\":\"de\"}.",
                "tags": [
                    "batch"
                ],
                "responses": {
                    "200": {
                        "description": "Resposta bem-sucedida",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object"
                                },
                                "example": [
                                    {
                                        "status": "success",
                                        "query": "8.8.8.8",
                                        "country": "Vereinigte Staaten",
                                        "city": "Mountain View"
                                    },
                                    {
                                        "status": "success",
                                        "query": "1.1.1.1",
                                        "country": "Australien",
                                        "city": "Sydney"
                                    }
                                ]
                            }
                        }
                    },
                    "default": {
                        "description": "Resposta de erro",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Error"
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "array",
                                "maxItems": 100,
                                "items": {
                                    "oneOf": [
                                        {
                                            "type": "string"
                                        },
                                        {
                                            "type": "object",
                                            "properties": {
                                                "query": {
                                                    "type": "string"
                                                },
                                                "lang": {
                                                    "type": "string"
                                                },
                                                "fields": {
                                                    "type": "string"
                                                }
                                            },
                                            "required": [
                                                "query"
                                            ]
                                        }
                                    ]
                                },
                                "example": [
                                    "8.8.8.8",
                                    "1.1.1.1"
                                ]
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "bearerAuth": {
                "type": "http",
                "scheme": "bearer",
                "description": "Chave FlowData como Authorization: Bearer fd_…"
            }
        },
        "schemas": {
            "Error": {
                "type": "object",
                "required": [
                    "error"
                ],
                "properties": {
                    "error": {
                        "type": "object",
                        "properties": {
                            "code": {
                                "type": "string"
                            },
                            "message": {
                                "type": "string"
                            },
                            "type": {
                                "type": "string"
                            },
                            "details": {
                                "type": "object"
                            }
                        }
                    }
                }
            }
        }
    }
}