Skip to main content

api.sh for Python

Official Python client for api.sh: public web data from around 1,000 websites as clean JSON: search engines, social media, e-commerce, real estate, jobs, travel, news and sports (Google, Amazon, TikTok, Zillow, LinkedIn and more). Every endpoint is a typed method.

pip install apish-sdk
from apish import Apish

apish = Apish()  # reads APISH_API_KEY; or Apish("ash_live_…")  (https://app.api.sh/keys)

profile = apish.tiktok.profile(username="nasa")
print(profile["followers"], profile.meta.credits_used, profile.meta.request_id)

results = apish.amazon.search(q="headphones", options={"raw": False})

Python 3.9+, sync (Apish) and asyncio (AsyncApish).

Calls

  • apish.<platform>.<endpoint>(**params, options=...): one method per endpoint, with keyword-only typed parameters and the price in its docstring.
  • apish.call(route, params, options): any route, e.g. apish.call("/reddit/v1/subreddit", {"subreddit": "python"}).
  • Options: raw (False leaves out raw source blocks), fields, fresh, output ("csv" / "ndjson" returns text), timeout, max_retries.
  • Results are dicts with .meta (request_id, credits_used, credits_remaining, status, seconds).
  • Retries 502/503/504 and network errors with backoff (failed calls are never charged).

Live catalog: counts, prices and new platforms

The typed methods cover every endpoint that existed when this version was published. The client also reads the live catalog (free, no credits, cached for an hour), so newer platforms and endpoints work without an upgrade:

cat = apish.catalog()                      # cat["platform_count"], cat["endpoint_count"]: today's numbers
prices = apish.prices()                    # route -> credits per call, live
apish.new_site.search(q="shoes")           # a platform added after this release
apish.hacker_news.some_new_endpoint(id="1")  # an endpoint added after this release
for page in apish.paginate("/reddit/v1/subreddit", {"subreddit": "python"}, max_pages=5):
    print(len(page["posts"]))

from apish import ApishError
try:
    apish.zillow.property(url=url)
except ApishError as e:
    print(e.status, e.message, e.insufficient_credits, e.spend_limit, e.request_id)

Async

import asyncio
from apish import AsyncApish

async def main():
    async with AsyncApish() as apish:
        print((await apish.reddit.subreddit(subreddit="python"))["posts"][0]["title"])

asyncio.run(main())

Account (free)

apish.account.get()            # balance, plan, spend, limits
apish.account.usage(days=30)
apish.account.logs(status="error")
apish.account.result(request_id)   # a past response again, free, 30 days

AI agents

from apish.tools import openai_tools, anthropic_tools, run_tool
tools = openai_tools()             # apish_search + apish_call (or openai_tools(["/tiktok/v1/profile"]))
text = run_tool(apish, name, arguments)   # when the model calls a tool

# LangChain:  pip install "apish-sdk[langchain]"
from apish.langchain import apish_tools
tools = apish_tools(apish)

For Claude Desktop, Cursor and other MCP clients, use the MCP server.

Docs: https://api.sh/docs/sdks · License: MIT

Metadata

Release files for apish-sdk 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apish-sdk 0.3.2
File Size Uploaded Provenance Actions
apish_sdk-0.3.2.tar.gz 1.9 MB Without provenance Details for apish_sdk-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apish-sdk 0.3.2
File Interpreter ABI Platform Actions
apish_sdk-0.3.2-py3-none-any.whl Python 3 none any Details for apish_sdk-0.3.2-py3-none-any.whl

Total release size: 3.7 MB

Release files / apish_sdk-0.3.2.tar.gz

Download URL apish_sdk-0.3.2.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
af2c4d6a3944b256f6964393f864ad78a310be7975470466415a9ed50e56b713
BLAKE2b-256 checksum
How to use checksums
161ef6abdaf58b62722d8c4655fd9e5a752b46225add86672d8cb6c4d253978d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Release files / apish_sdk-0.3.2-py3-none-any.whl

Download URL apish_sdk-0.3.2-py3-none-any.whl
Size 1.9 MB
Tags Python 3
SHA-256 checksum
How to use checksums
48ea6354523ab1e68f165ba5cbd3f7178ba20032c0e7d2518a6b1c00d44d452b
BLAKE2b-256 checksum
How to use checksums
c114847ac2e96d47c5819d67666ee7379c5e13761d469f0453693c6f335847f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Security for apish-sdk 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page