Skip to main content

This official Python SDK is the synchronous way to integrate with Linked API. It provides pre-defined workflow operations, direct account/statistics methods, admin APIs, authentication headers, polling, and structured error responses.

Get started

To get started with Linked API Python SDK, read these essential guides first:

  1. Core concepts - understand how Linked API works.
  2. Installation & authorization - install the SDK and authorize it.
  3. Predefined vs. custom workflows - choose ready-made operations or custom workflow definitions.
  4. Handling results and errors - process successful data and action errors.
  5. Persisting and cancelling workflows - save, resume, and cancel workflows.

Install the package:

pip install linkedapi

Initialize the client:

from linkedapi import LinkedApi, LinkedApiConfig

linkedapi = LinkedApi(
    LinkedApiConfig(
        linked_api_token="your-linked-api-token",
        identification_token="your-identification-token",
    )
)

Run a predefined workflow and poll the result:

from linkedapi import FetchPersonParams

workflow = linkedapi.fetch_person.execute(
    FetchPersonParams(
        person_url="https://www.linkedin.com/in/john-doe",
        retrieve_experience=True,
        retrieve_posts=True,
        posts_retrieval_config={"limit": 10},
    )
)

result = linkedapi.fetch_person.result(workflow.workflow_id)
if result.data:
    print(result.data.name)
for error in result.errors:
    print(error.type, error.message)

Execute a custom workflow:

workflow = linkedapi.custom_workflow.execute(
    {
        "actionType": "st.searchCompanies",
        "term": "Tech Inc",
        "filter": {
            "sizes": ["51-200", "2001-5000"],
            "locations": ["San Francisco", "New York"],
            "industries": ["Software Development"],
        },
        "then": {"actionType": "st.openCompanyPage", "basicInfo": True},
    }
)

result = linkedapi.custom_workflow.result(workflow.workflow_id)
print(result.data)

Continue polling after a workflow timeout:

from linkedapi import LinkedApiWorkflowTimeoutError

try:
    result = linkedapi.fetch_person.result(workflow.workflow_id, timeout=30.0)
except LinkedApiWorkflowTimeoutError as error:
    result = linkedapi.fetch_person.result(error.workflow_id)

Cancel a workflow:

cancelled = linkedapi.fetch_person.cancel(workflow.workflow_id)
print(cancelled)

License

This project is licensed under the MIT License. See LICENSE for details.

Metadata

Release files for linkedapi 1.4.8

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

Source distribution (sdist)

Source distribution for linkedapi 1.4.8
File Size Uploaded Provenance Actions
linkedapi-1.4.8.tar.gz 53.9 kB With provenance Details for linkedapi-1.4.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for linkedapi 1.4.8
File Interpreter ABI Platform Actions
linkedapi-1.4.8-py3-none-any.whl Python 3 none any Details for linkedapi-1.4.8-py3-none-any.whl

Total release size: 126.1 kB

Release files / linkedapi-1.4.8.tar.gz

Download URL linkedapi-1.4.8.tar.gz
Size 53.9 kB
Tags Source
SHA-256 checksum
How to use checksums
9238240bcca0b223591f039a5a18d1f971c6e8c0dde86f988a7beb6a1a04edd7
BLAKE2b-256 checksum
How to use checksums
b8f9ee2b630fd866752e3640f04b1333273412e60d48bdf8c0b741fde76c8e56
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Release files / linkedapi-1.4.8-py3-none-any.whl

Download URL linkedapi-1.4.8-py3-none-any.whl
Size 72.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
136e41e099adc0a396b8a380f5078825dd1e1f770f4d1c66b5836dd722ae56d5
BLAKE2b-256 checksum
How to use checksums
d96061e0b5d644c59bdba9beea96d62fcdba40af53e6a92de9e9002a3074842f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Security for linkedapi 1.4.8

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for linkedapi-1.4.8.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

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

1.4.8 This release

2 release files Full 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