a6mg71so.nx.link

{
  "parameters": [
    {
      "description": "Search query. Example: 'best ai automation agencies'.",
      "in": "query",
      "name": "q",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Location for localized search results. Example: 'Paris, France'.",
      "in": "query",
      "name": "location",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Language code (ISO 639-1).",
      "in": "query",
      "name": "hl",
      "schema": {
        "default": "en",
        "type": "string"
      }
    },
    {
      "description": "Country code (ISO 3166-1 alpha-2).",
      "in": "query",
      "name": "gl",
      "schema": {
        "default": "us",
        "type": "string"
      }
    },
    {
      "description": "Google domain for the search.",
      "in": "query",
      "name": "google_domain",
      "schema": {
        "default": "google.com",
        "type": "string"
      }
    },
    {
      "description": "Number of results to return (max 100).",
      "in": "query",
      "name": "num",
      "schema": {
        "default": 10,
        "type": "integer"
      }
    },
    {
      "description": "Pagination offset.",
      "in": "query",
      "name": "start",
      "schema": {
        "default": 0,
        "type": "integer"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "example": {
            "organic_results": [
              {
                "link": "https://fleeceai.agency",
                "position": 1,
                "snippet": "Helping companies automate workflows using AI.",
                "title": "Fleece AI – AI Automation Agency"
              }
            ],
            "search_metadata": {
              "credits_used": 1,
              "engine": "google",
              "status": "Success",
              "time_taken": 0.45,
              "total_results": 1000000
            }
          },
          "schema": {
            "properties": {
              "organic_results": {
                "items": {
                  "properties": {
                    "link": {
                      "description": "URL of the result",
                      "format": "uri",
                      "type": "string"
                    },
                    "position": {
                      "description": "Position in search results",
                      "type": "integer"
                    },
                    "snippet": {
                      "description": "Brief description or snippet",
                      "type": "string"
                    },
                    "title": {
                      "description": "Title of the result",
                      "type": "string"
                    }
                  },
                  "required": [
                    "position",
                    "title",
                    "link"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "search_metadata": {
                "properties": {
                  "credits_used": {
                    "description": "Number of credits consumed for this search",
                    "type": "integer"
                  },
                  "engine": {
                    "enum": [
                      "google",
                      "youtube",
                      "amazon",
                      "apple_app_store"
                    ],
                    "type": "string"
                  },
                  "status": {
                    "enum": [
                      "Success",
                      "Error",
                      "Rate Limited"
                    ],
                    "type": "string"
                  },
                  "time_taken": {
                    "description": "Time taken for the search in seconds",
                    "type": "number"
                  },
                  "total_results": {
                    "description": "Total number of results available",
                    "type": "integer"
                  }
                },
                "required": [
                  "status",
                  "engine"
                ],
                "type": "object"
              }
            },
            "required": [
              "search_metadata",
              "organic_results"
            ],
            "type": "object"
          }
        }
      },
      "description": "Successful Google search response"
    },
    "400": {
      "content": {
        "application/json": {
          "example": {
            "code": "MISSING_PARAMETER",
            "details": "The search query parameter 'q' is required",
            "error": "Missing required parameter: q"
          },
          "schema": {
            "properties": {
              "code": {
                "description": "Error code",
                "type": "string"
              },
              "details": {
                "description": "Additional error details",
                "type": "string"
              },
              "error": {
                "description": "Error message",
                "type": "string"
              }
            },
            "required": [
              "error",
              "code"
            ],
            "type": "object"
          }
        }
      },
      "description": "Bad Request - Invalid parameters"
    },
    "401": {
      "content": {
        "application/json": {
          "example": {
            "code": "INVALID_API_KEY",
            "details": "The provided API key is not valid or has expired",
            "error": "Invalid API key"
          },
          "schema": {
            "properties": {
              "code": {
                "description": "Error code",
                "type": "string"
              },
              "details": {
                "description": "Additional error details",
                "type": "string"
              },
              "error": {
                "description": "Error message",
                "type": "string"
              }
            },
            "required": [
              "error",
              "code"
            ],
            "type": "object"
          }
        }
      },
      "description": "Unauthorized - Invalid API key"
    },
    "429": {
      "content": {
        "application/json": {
          "example": {
            "code": "RATE_LIMIT_EXCEEDED",
            "error": "Rate limit exceeded",
            "quota_reset": "2024-01-15T10:30:00Z",
            "retry_after": 60
          },
          "schema": {
            "properties": {
              "code": {
                "example": "RATE_LIMIT_EXCEEDED",
                "type": "string"
              },
              "error": {
                "example": "Rate limit exceeded",
                "type": "string"
              },
              "quota_reset": {
                "description": "When the quota resets",
                "format": "date-time",
                "type": "string"
              },
              "retry_after": {
                "description": "Seconds to wait before retrying",
                "type": "integer"
              }
            },
            "required": [
              "error",
              "code",
              "retry_after"
            ],
            "type": "object"
          }
        }
      },
      "description": "Too Many Requests - Rate limit exceeded"
    },
    "500": {
      "content": {
        "application/json": {
          "example": {
            "code": "INTERNAL_ERROR",
            "details": "An unexpected error occurred while processing the request",
            "error": "Internal server error"
          },
          "schema": {
            "properties": {
              "code": {
                "description": "Error code",
                "type": "string"
              },
              "details": {
                "description": "Additional error details",
                "type": "string"
              },
              "error": {
                "description": "Error message",
                "type": "string"
              }
            },
            "required": [
              "error",
              "code"
            ],
            "type": "object"
          }
        }
      },
      "description": "Internal Server Error"
    }
  }
}