Metadata-Version: 2.5
Name: openai-agents-datacircle
Version: 0.1.0
Summary: OpenAI Agents SDK tools for the Datacircle API: find the best GTM APIs
Project-URL: Homepage, https://datacircle.dev
Project-URL: Documentation, https://api.datacircle.dev/v1/openapi.json
Project-URL: Repository, https://github.com/waynehamadi/openai-agents-datacircle-python
License-Expression: MIT
License-File: LICENSE
Keywords: agents,api,api-pricing,b2b-data,datacircle,function-tools,gtm,openai-agents,openai-agents-sdk,tools
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Requires-Dist: openai-agents>=0.3.0
Requires-Dist: requests>=2.25
Description-Content-Type: text/markdown

# openai-agents-datacircle

Find the best GTM APIs. We benchmark all the GTM APIs and we put the results on our website: https://datacircle.dev

This package gives the [OpenAI Agents SDK](https://github.com/openai/openai-agents-python) four function tools on Datacircle's open API, https://api.datacircle.dev/v1. You need no key and no account.

```bash
pip install openai-agents-datacircle
```

| Tool | What it gives | Call |
| --- | --- | --- |
| `datacircle_list_apis` | Every GTM API on Datacircle, with its slug, number of plans and providers, and its best plan | `GET /apis` |
| `datacircle_best_plans` | One API's plans, best first by score out of 100, each with its rank and price per 1,000 calls | `GET /apis/{slug}/best` |
| `datacircle_search_plans` | Plans by provider or plan name, on every API or one, sorted by score, provider or price | `GET /plans` |
| `datacircle_provider` | The APIs a provider sells and its rank on each | `GET /providers/{slug}` |

## Use

```python
from agents import Agent, Runner
from openai_agents_datacircle import datacircle_tools

agent = Agent(
    name="GTM assistant",
    instructions="Answer from the datacircle tools.",
    tools=datacircle_tools(),
)
result = Runner.run_sync(agent, "Which email finder API is best for under $5 per 1,000?")
print(result.final_output)
```

Any model the SDK runs works. `datacircle_tools(include=["best_plans", "provider"])` gives only some of the tools. Each tool is a `FunctionTool` with the SDK's strict schema: the model sends every argument, `null` for one it leaves out. Each one gives the model its answer as JSON.

Each tool is also a plain function that gives a dict:

```python
from openai_agents_datacircle import best_plans

best_plans(slug="email-finder", limit=3)
```

Each plan comes with its rank, provider, plan, score, price per 1,000 (`perThousand`, in dollars) and its page on datacircle.dev, which lists every field. An unknown slug or a value out of range comes back as `{"error": ...}` with the API's words (an unknown API's answer lists every slug), so the model can call again.

## Network

Each call makes one HTTPS GET to https://api.datacircle.dev/v1 with the tool's arguments and nothing else. The API takes up to 60 calls a minute from one address; the tools wait once, a minute at most, when it asks them to. `datacircle_tools(timeout=10)` sets how long a call may take. Every plan is also one file at https://datacircle.dev/datacircle.json.

## Links

- Datacircle: https://datacircle.dev
- The API: https://datacircle.dev/api
- Its spec: https://api.datacircle.dev/v1/openapi.json
- What each key means: https://datacircle.dev/fields

MIT license.
