Connecting to Belvo API
In order to use Belvo API, you will have to login into a new session by using a secret key.
Secret keys are generated from the Belvo API dashboard. For more information, please visit our Developers portal
def __init__(secret_key_id: str, secret_key_password: str, url: str = None) -> None: ...
You must provide
url tells the client to which Belvo API host should attempt to connect,
this allows you to switch from a sandbox to a production environment.
You can also set which Belvo API host to use, by setting the
When creating a new instance of
Client, it will automatically perform a login
and create a
JWTSession (if the credentials are valid).
# Creating a client instance to connect to Belvo API from belvo.client import Client my_client = Client( "your-secret-key-id", "your-secret-key-password", "https://api.belvo.com" ) # Creating a client that takes url from the environment. # We assume that you have set BELVO_API_URL before # (e.g. export BELVO_API_URL=https://sandbox.belvo.com my_client = Client( "your-secret-key-id", "your-secret-key-password" )
All resources in the Belvo API are nested attributes in your client instance, these resources are available only if you provide valid credentials.