This guide provides a hands-on introduction for working with the State Street API. Use this section to understand how to create your API Application and perform a successful request and retrieve a sample dataset.

Steps

1. Log in to the State Street Developer Portal
2. Navigate to the Sample Transactions API 
3. Register New Application
4. Retrieve Results

Navigate to Login at the top of this page, where you will be prompted for your account details

Enter your login credentials, and once verified, you can proceed to the next step. If you do not yet have a my.statestreet.com account that has access to the State Street Developer Portal, please contact your Client Service Manager to obtain access.

1. Click on the Products tab on the top navigation bar and then API Catalog
   
2. Find the Sample Transactions API within the API grid. You may only see the Sample Transactions API, or you may see more available to you. The API catalog view is controlled by permissions granted by your Client Service Manager for specific API products, based on your organization’s scope of services
   
3. Click on “View Documentation” 

 To make API calls, you must register an Application within the State Street Developer Portal. This is the consistent process, regardless of which method you use to access the State Street API.
 

1. Once within the Sample Transaction API, you will see the endpoint overview page  
2. Click on Reference to view the Sample Transactions API specifications. If you have not used this function before you will see a banner that says “You do not have any applications registered.”
    
3. Click on “Add App” to register an application
4. Name your application and ensure "Sample Transactions" is enabled in the API Catalog section
5. Click Add App to complete the registration. 
6. To try the API you need to retrieve an access token to establish a session. Click Authorize and a success message will appear on the top of the page
   

1. Scroll down to view the Transaction API Endpoints
   
2. Click on the arrow next to “/GET” to expand the endpoint
   
3. Click on the “Try it out” button
4. There will be parameters below that can be modified, but can also be left blank. Click on "Execute" to initiate the request.
   
5. The sample request will be completed. On the console to the right there will be the request written in curl, as well as the server response. Congratulations on your first successful request with State Street API!

You are ready to leverage API solutions

• Develop solutions with common tools and languages
• Learn more about how to configure and use OAuth Applications
• Discover APIs within the API Catalog

For support, email api-support@statestreet.com, call a Helpdesk, or engage your Client Service Manager.