Skip to main content

Usage

Obtaining a JWT Token

You can retrieve a JWT token via an API POST request using the following URL pattern: https://{domain_name}/{realm_code}/{space_code}/api/v1/auth-tokens/personal-access-token/create-token/

Sending Data for a Single Portfolio

  1. In the sender space, go to Workflow → Home.

  2. Locate and run the workflow with user code: com.finmars.finmars-to-finmars:send

  3. Use the following payload data format when running the workflow:

    {
       "portfolio_code": "<The portfolio code in the current space>",
       "export_date": "<The date of the export>",
       "domain_name": "<The domain name of the private client space>",
       "realm_code": "<The realm code of the private client space>",
       "space_code": "<The space code of the private client space>",
       "jwt_token": "<The JWT token for accessing the private client space>"
    }

Sending Data for a Date Range

  1. In the sender space, go to Workflow → Home.

  2. Locate and run the workflow with user code: com.finmars.finmars-to-finmars:send

  3. Use the following payload data format:

    {
       "export_date_from": "<Start date of the export>",
       "export_date_to": "<End date of the export>",
       "domain_name": "<The domain name of the private client space>",
       "realm_code": "<The realm code of the private client space>",
       "space_code": "<The space code of the private client space>",
       "jwt_token": "<The JWT token for accessing the private client space>"
    }