Skip to main content

Official Python SDK for Foxcite AVS and AEO Monitoring platform

Project description

Foxcite Python SDK

PyPI version License: MIT

The official Python client library for the Foxcite API. Foxcite is an Answer Engine Optimization (AEO) and ai search visibility tool that helps modern agencies and brands track their presence across major LLMs (ChatGPT, Claude, Gemini, Grok, and Perplexity).

Features

  • Fully Typed: Exposes fully typed Pydantic v2 schemas for all requests and responses.
  • Sync & Async Support: Native support for both synchronous (requests) and asynchronous (httpx) execution.
  • High Concurrency Ready: Built-in connection pooling and socket management designed for high-throughput AI agent loops.

Installation

pip install foxcite-sdk

Quick Start

You can generate an API Key from your Foxcite Dashboard.

Synchronous Client

from foxcite import Foxcite

# The client uses a context manager to gracefully handle connection pools
with Foxcite(api_key="seomd_live_...") as client:
    # List brand workspaces
    brands = client.brands.list()
    print("Brands:", [b.name for b in brands])

    # Execute a quick AEO audit
    audit = client.audits.quick_audit(
        name="My Brand",
        domain="mybrand.com",
        niche="SaaS Analytics",
        query="best saas analytics tools"
    )
    print("Quick Audit Scan ID:", audit.scan_id)

Asynchronous Client

import asyncio
from foxcite import AsyncFoxcite

async def main():
    async with AsyncFoxcite(api_key="seomd_live_...") as client:
        brands = await client.brands.list()
        print("Brands:", [b.name for b in brands])

if __name__ == "__main__":
    asyncio.run(main())

Developer Notes: Connection Pooling

Under the hood, the Python SDK manages persistent TCP connections.

  • The synchronous Foxcite client utilizes a requests.Session().
  • The asynchronous AsyncFoxcite client utilizes an httpx.AsyncClient().

Always use the client within a with or async with context manager to ensure sockets are properly released, preventing file descriptor leaks during high-concurrency background tasks.

Contributing

  1. Clone the repository.
  2. Create a virtual environment: python3 -m venv .venv && source .venv/bin/activate
  3. Install dependencies: pip install -e .
  4. Run tests: pytest tests/

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foxcite_sdk-1.0.3.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

foxcite_sdk-1.0.3-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file foxcite_sdk-1.0.3.tar.gz.

File metadata

  • Download URL: foxcite_sdk-1.0.3.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for foxcite_sdk-1.0.3.tar.gz
Algorithm Hash digest
SHA256 80766067c0f3d7c0d2b9bfde5a29c29f511d5acc9a27af5871bee7f5a4a14649
MD5 228bcdbac052cbb2b434e589b8249b65
BLAKE2b-256 63fae89f88b5bd5ef977cd271bfc98490bd17a649bc39aff2a5bf2d05a26fbd0

See more details on using hashes here.

File details

Details for the file foxcite_sdk-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: foxcite_sdk-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for foxcite_sdk-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1ad2bf37a38896b9fb0d249769b41ee1b8add6affe797e8f9d761965ce9eb30e
MD5 fcf20a6acd0bd03ea362004309fa9f5a
BLAKE2b-256 66bda7d87dd1f1e773b5a997ee3e2725a85df97c9f27ccc80dc92a8b12f97f3c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page