Skip to main content

Client Secret

Table of Contents

Description

Financial meaning

It stores the data of an API key of broker, bank, API. It provides a single point of access to user data and API keys (third-party services) associated with customer portfolios.

Platform abstraction

Client Secret in the Finmars platform is information about the client's API key, which refers to:

  • client container for client information. 

Examples

User code
 Provider
 Portfolio
 Path to Secret
 Client ID
 Notes
client-00 Bank A
 Bonds Portfolio
 finmars/bank-a-access 1
 -
  • User code: workspace unique identifier of the client
  • Provider: name of broker, source, bank, API
  • Portfolio: portfolio name
  • Path to Secret:  path to the vault (with API key)
  • Notes: custom description
  • Client ID: ID of client

Cookbook

CRUD

Operations within platform.

Use Cases

Now u can use some thing like this in workflow script:

payload = kwargs.get("payload")
path_to_secretclient = payload.get("path_to_secret"client")
secrets = workflow.finmars.get_secrets(client, provider="exante") 

credentials = vault.get_secret(secret.path_to_secret)

F.A.Q.

API documentation

Back to top