menu
Guides

GsSession

Prerequisites

Refer to Institutional Documentation for a foundation on using institutional services.

  1. Register an application.
  2. Generate an authorization token for your application.
  3. Make your first API call.

GsSession manages authentication for the GS Developer APIs. This class allows you to hold an authentication context to the developer APIs within a given process. You can hold a reference to multiple sessions within the same process.

OAuth

Authenticating with OAuth application credentials.

info

Note

Application credentials can be created through the Marquee Developer Site. OAuth is the recommended approach for Goldman Sachs clients.

Create and use a GsSession with OAuth application credentials:

from gs_quant.session import GsSession

client_id = 'YOUR_CLIENT_ID'
client_secret = 'YOUR_CLIENT_SECRET'

GsSession.use(client_id=client_id, client_secret=client_secret)

Replace the above clientid and client_secret with your own credentials.

Single-Sign-On

Where SSO is available, users can authenticate as follows:

from gs_quant.session import GsSession

GsSession.use()

Scopes

GS Developer scopes provide access to different capabilities within GS Quant. These scopes can be requested through the Application Management Portal. Scopes are linked to your registered application. You can create multiple applications with different scopes in order to protect your processes. For example, your trading application may require the execute_trades scope, but you wouldn't need other applications which only read data to have these elevated permissions. More information on the different scopes is available here.

To initialize a session with the default set of scopes:

from gs_quant.session import GsSession

client_id = 'YOUR_CLIENT_ID'
client_secret = 'YOUR_CLIENT_SECRET'

scopes = GsSession.Scopes.get_default()

GsSession.use(client_id=client_id, client_secret=client_secret, scopes=scopes)

To initialize a session with the a specific set of scopes:

from gs_quant.session import GsSession

client_id = 'YOUR_CLIENT_ID'
client_secret = 'YOUR_CLIENT_SECRET'

scopes = [
    GsSession.Scopes.MODIFY_FINANCIAL_DATA,
    GsSession.Scopes.READ_FINANCIAL_DATA
]

GsSession.use(client_id=client_id, client_secret=client_secret, scopes=scopes)

Environments

Developers can access different environments using the provided constants. Production environments should be used for all GS Quant access except where testing workflows prior to deployment (e.g. testing trading integration).

from gs_quant.session import Environment

GsSession.use(environment_or_domain=Environment.QA, client_id=client_id, client_secret=client_secret, scopes=scopes)

Related Content


Certain solutions and Institutional Services described herein are provided via our Marquee platform. The Marquee platform is for institutional and professional clients only. This site is for informational purposes only and does not constitute an offer to provide the Marquee platform services described, nor an offer to sell, or the solicitation of an offer to buy, any security. Some of the services and products described herein may not be available in certain jurisdictions or to certain types of clients. Please contact your Goldman Sachs sales representative with any questions. Any data or market information presented on the site is solely for illustrative purposes. There is no representation that any transaction can or could have been effected on such terms or at such prices. Please see https://www.goldmansachs.com/disclaimer/sec-div-disclaimers-for-electronic-comms.html for additional information.
Transaction Banking services are offered by Goldman Sachs Bank USA (“GS Bank”). GS Bank is a New York State chartered bank, a member of the Federal Reserve System and a Member FDIC.
GS DAP™ is owned and operated by Goldman Sachs. This site is for informational purposes only and does not constitute an offer to provide, or the solicitation of an offer to provide access to or use of GS DAP™. Any subsequent commitment by Goldman Sachs to provide access to and / or use of GS DAP™ would be subject to various conditions, including, amongst others, (i) satisfactory determination and legal review of the structure of any potential product or activity, (ii) receipt of all internal and external approvals (including potentially regulatory approvals); (iii) execution of any relevant documentation in a form satisfactory to Goldman Sachs; and (iv) completion of any relevant system / technology / platform build or adaptation required or desired to support the structure of any potential product or activity.
Mosaic is a service mark of Goldman Sachs & Co. LLC. This service is made available in the United States by Goldman Sachs & Co. LLC and outside of the United States by Goldman Sachs International, or its local affiliates in accordance with applicable law and regulations. Goldman Sachs International and Goldman Sachs & Co. LLC are the distributors of the Goldman Sachs Funds. Depending upon the jurisdiction in which you are located, transactions in non-Goldman Sachs money market funds are affected by either Goldman Sachs & Co. LLC, a member of FINRA, SIPC and NYSE, or Goldman Sachs International. For additional information contact your Goldman Sachs representative. Goldman Sachs & Co. LLC, Goldman Sachs International, Goldman Sachs Liquidity Solutions, Goldman Sachs Asset Management, L.P., and the Goldman Sachs funds available through Goldman Sachs Liquidity Solutions and other affiliated entities, are under the common control of the Goldman Sachs Group, Inc.
© 2024 Goldman Sachs. All rights reserved.