Skip to content

structure-ac/structure-python

Repository files navigation

Python SDK

Discover rich information on people and companies

SDK Installation

pip install structure_py

Authentication

You'll need to authenticate your requests to access any of the endpoints in the Structure API. In this guide, we'll look at how authentication works. Structure offers authentication for your API requests with a token.

OAuth2 with bearer token

Authentication with the Structure API is using OAuth2. When establishing a connection using OAuth2, you will need your access token — you will find it in the Structure dashboard under API settings.

SDK Example Usage

import sdk
from sdk.models import operations

s = sdk.SDK(
    security=shared.Security(
        bearer_auth="",
    ),
)

req = operations.EnrichCompanyRequest(
    id='89bd9d8d-69a6-474e-8f46-7cc8796ed151',
)

res = s.companies.enrich(req)

if res.body is not None:
    # handle response

Available Resources and Operations

  • login - Login user
  • me - Show current user

Maturity

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.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

SDK Created by Speakeasy