Getting started with Alphasense Python SDK

Installation

Before installing; you should create the virtual environment

pip install alphasense-api-sdk

or specify the version

pip install alphasense-api-sdk==<version>

Or adding the alphasense-api-sdk to the pyproject.toml file

dependencies = [
  "alphasense-api-sdk==<version>"
]

or requirements.txt file

alphasense-api-sdk==<version>

Usage

• Create pyproject.toml file
• Add the following to the pyproject.toml file

[alphasense.auth]
username = "<your username>"
password = "<your password>"
api_key = "<your api key>"
client_id = "<your client id>"
client_secret = "<your client secret>"

• Writing the code to fetch the watchlists with raw GraphQL query

from alphasense_api_sdk.client import Client, GraphQLField

async def main():
    client = Client()
    w = await client.query(
        GraphQLField("user { watchlists { id name }}"), operation_name="user_watchlists"
    )
    print("Watchlists: ", w)


if __name__ == "__main__":
    import asyncio

    asyncio.run(main())

• Or using the Query object to search for documents

from alphasense_api_sdk.client import Client, GraphQLField
from alphasense_api_sdk.custom_queries import Query, SearchResponseFields


async def main():
    client = Client()
    df = SearchResponseFields.documents()
    search_query = Query.search(limit=5).fields(
        SearchResponseFields.documents().fields(
            df.id,
            df.title,
            df.released_at,
            GraphQLField("type { ids }"),
        )
    )
    docs = await client.query(search_query, operation_name="searchDocs")
    print("> docs: ", docs)


if __name__ == "__main__":
    import asyncio

    asyncio.run(main())