Developer-friendly & type-safe Python SDK specifically catered to leverage exfunc API.
Exfunc APIs: # Authentication
Exfunc offers one form of authentication:
- API Key
Note
Python version upgrade policy
Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with uv, pip, or poetry package managers.
uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
uv add exfuncPIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install exfuncPoetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.
poetry add exfuncYou can use this SDK in a Python shell with uv and the uvx command that comes with it like so:
uvx --from exfunc pythonIt's also possible to write a standalone Python script without needing to set up a whole project like so:
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "exfunc",
# ]
# ///
from exfunc import Exfunc
sdk = Exfunc(
# SDK arguments
)
# Rest of script here...Once that is saved to a file, you can run it with uv run script.py where
script.py can be replaced with the actual file name.
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
# Synchronous Example
from exfunc import Exfunc
import os
with Exfunc(
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
res = e_client.glassdoor.search_job_postings(request={})
# Handle response
print(res)The same SDK client can also be used to make asynchronous requests by importing asyncio.
# Asynchronous Example
import asyncio
from exfunc import Exfunc
import os
async def main():
async with Exfunc(
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
res = await e_client.glassdoor.search_job_postings_async(request={})
# Handle response
print(res)
asyncio.run(main())Available methods
- search_job_postings - Search job postings on Glassdoor
- get_job_posting - Get job posting details from Google
- get_product - Get product details from Google
- get_product_reviews - Get product reviews from Google
- search_job_postings - Search job postings on Google
- search_news - Search news articles on Google
- search_products - Search products on Google
- search_web - Search web on Google
- search_job_postings - Search job postings on Indeed
- get_company - Get LinkedIn company info
- get_job_posting - Get LinkedIn job posting info
- get_person - Get LinkedIn person profile info
- search_companies - Search for LinkedIn companies
- search_job_postings - Search for LinkedIn job postings
- search_people - Search for LinkedIn people
- get_task - Get web navigator task results
- start_task - Start a web navigator task
- scrape - Scrape a web page
- search_flights - Search flights on SkyScanner
- get_tweet - Get a tweet by ID
- get_user - Get a Twitter user by either user ID or username
- get_user_followers - Get a Twitter user's followers by username
- get_user_followings - Get a Twitter user's followings by username
- get_user_tweets - Get a Twitter user's tweets by username
- search_tweets - Search Twitter for tweets
- search_users - Search Twitter for users
- get_business - Get business details from Yelp
- get_business_reviews - Get Yelp reviews for a business
- search_businesses - Search for businesses on Yelp
- get_property - Get property details from Zillow
- search_properties - Search for properties on Zillow
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:
from exfunc import Exfunc
from exfunc.utils import BackoffStrategy, RetryConfig
import os
with Exfunc(
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
res = e_client.glassdoor.search_job_postings(request={},
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle response
print(res)If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:
from exfunc import Exfunc
from exfunc.utils import BackoffStrategy, RetryConfig
import os
with Exfunc(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
res = e_client.glassdoor.search_job_postings(request={})
# Handle response
print(res)ExfuncError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
err.message |
str |
Error message |
err.status_code |
int |
HTTP response status code eg 404 |
err.headers |
httpx.Headers |
HTTP response headers |
err.body |
str |
HTTP body. Can be empty string if no body is returned. |
err.raw_response |
httpx.Response |
Raw HTTP response |
err.data |
Optional. Some errors may contain structured data. See Error Classes. |
from exfunc import Exfunc, models
import os
with Exfunc(
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
res = None
try:
res = e_client.glassdoor.search_job_postings(request={})
# Handle response
print(res)
except models.ExfuncError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrown
if isinstance(e, models.UserError):
print(e.data.message) # Optional[str]Primary errors:
ExfuncError: The base class for HTTP error responses.UserError: User error response. Status code400.ServerError: Server error response. Status code500.
Less common errors (5)
Network errors:
httpx.RequestError: Base class for request errors.httpx.ConnectError: HTTP client was unable to make a request to a server.httpx.TimeoutException: HTTP request timed out.
Inherit from ExfuncError:
ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via thecauseattribute.
The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
from exfunc import Exfunc
import os
with Exfunc(
server_url="https://api.exfunc.dev",
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
res = e_client.glassdoor.search_job_postings(request={})
# Handle response
print(res)The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from exfunc import Exfunc
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Exfunc(client=http_client)or you could wrap the client with your own custom logic:
from exfunc import Exfunc
from exfunc.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Exfunc(async_client=CustomClient(httpx.AsyncClient()))This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
api_key |
apiKey | API key | EXFUNC_API_KEY |
To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:
from exfunc import Exfunc
import os
with Exfunc(
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
res = e_client.glassdoor.search_job_postings(request={})
# Handle response
print(res)The Exfunc class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.
from exfunc import Exfunc
import os
def main():
with Exfunc(
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
# Rest of application here...
# Or when using async:
async def amain():
async with Exfunc(
api_key=os.getenv("EXFUNC_API_KEY", ""),
) as e_client:
# Rest of application here...You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from exfunc import Exfunc
import logging
logging.basicConfig(level=logging.DEBUG)
s = Exfunc(debug_logger=logging.getLogger("exfunc"))You can also enable a default debug logger by setting an environment variable EXFUNC_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.