Official Python SDK for the Metalift web context API
Project description
metalift-sdk
Official Python SDK for Metalift — turn any URL into agent-ready markdown, HTML, or structured data.
Install
pip install metalift-sdk
Requires Python 3.10+.
Quick start
from metalift_sdk import Metalift
client = Metalift(api_key="YOUR_API_KEY")
result = client.scrape(
"https://example.com",
formats=["markdown"],
)
print(result["data"]["markdown"])
Get an API key from the Metalift dashboard. New accounts receive 1,000 free credits/month.
Configuration
from metalift_sdk import Metalift
client = Metalift(
api_url="https://api.metalift.ai", # default
api_key="YOUR_API_KEY",
timeout=60.0,
)
Environment variables are also supported:
| Variable | Description |
|---|---|
METALIFT_API_URL |
API base URL (default: https://api.metalift.ai) |
METALIFT_API_KEY |
Bearer token for authenticated requests |
API
Scrape
client.scrape(
"https://example.com",
formats=["markdown"],
render="auto",
only_main_content=True,
strategy="default",
)
Batch scrape
client.batch(
["https://example.com", "https://example.org"],
async_=True,
scrape_options={"formats": ["markdown"]},
)
Crawl and map
crawl_job = client.crawl("https://example.com", limit=50)
map_result = client.map("https://example.com", limit=100)
Async jobs
job = client.crawl("https://example.com", limit=20)
completed = client.wait_for_job(job["job_id"])
print(completed["status"], completed.get("data"))
Strategies and protected sites
strategies = client.list_strategies()
protection = client.list_protection_types()
client.scrape(
"https://www.walmart.com/ip/EXAMPLE",
strategy="retail",
formats=["markdown"],
)
client.fetch_session(url="https://www.walmart.com/", domain="www.walmart.com")
Session cookies
client.seed_session(
domain="example.com",
cookies=[{"name": "session", "value": "...", "domain": "example.com", "path": "/"}],
)
Errors
API failures raise MetaliftError:
from metalift_sdk import Metalift, MetaliftError
try:
client.scrape("https://example.com")
except MetaliftError as exc:
print(exc.status_code, exc.detail)
Links
License & distribution
metalift-sdk is proprietary software licensed under the terms in LICENSE. Use, copying, modification, and redistribution are not permitted except as expressly authorized by Metalift.
The package is published on the public Python Package Index (PyPI) so customers can install it with pip install metalift-sdk. Publishing on PyPI does not make the software open source: the wheel and source archive are publicly downloadable, but legal use remains governed by the proprietary license.
Do not commit API keys or other credentials into your application code. Pass them at runtime via the api_key argument or the METALIFT_API_KEY environment variable.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file metalift_sdk-1.0.3.tar.gz.
File metadata
- Download URL: metalift_sdk-1.0.3.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3bcb779733bc2555da47717d7ea74e2afb5f90819ff45657e9baf7ea96cb0f03
|
|
| MD5 |
f6e1c257f1690f401d232b6ae3a8e2e8
|
|
| BLAKE2b-256 |
53df6db82614bd5c228f3973a86f902acc70b3abe2f85fe2e062d6e9eda932da
|
File details
Details for the file metalift_sdk-1.0.3-py3-none-any.whl.
File metadata
- Download URL: metalift_sdk-1.0.3-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
63a3e589abf4899cf7d80ca624ca1db85539beab7134551c1c2675ac3051330e
|
|
| MD5 |
ffd313cc999eb949db8f463f72735545
|
|
| BLAKE2b-256 |
23393f13e88660205920b744359860397c253e47a71251c6ef1a85ed35f20968
|