FAQ

Authentication & Testing

How are Carta APIs authenticated?

Carta’s API uses the OAuth 2.0 open specification to authorize your access to our data, and supports AUTHORIZATION_CODE and CLIENT_CREDENTIALS grant types. Please see more details on our OAuth flow.

What are the data fields provided via the APIs?

Our API Reference documents response fields and definitions for each API endpoint under the section labeled Responses, 200.

What are the base URLs for each environment?

The base URLs are as follows:

• Playground: https://api.playground.carta.team
• Production: https://api.carta.com

Can I interact with sample data prior to getting playground access?

Yes, Carta offers a mocking service that provides sample API response data.

I've run into an INSUFFICIENT_SCOPE 403 error when trying to access an API. How can I resolve this?

This issue might be two-fold: either the scope has not been enabled for your application, which can be updated via our developer portal, and/or the end-user has not enabled this particular permissions for your organization to access. Read more about understanding scopes.

What are the rate limits for your APIs?

See details about our rate limits for the Playground and Production environments.

Investor API

Does the Get Capitalization Table API show fund-level portfolio holdings?

Yes, this API provides cap table views at (I) the share class level, and (II) the stakeholder level. This means you can programmatically access your investment fund's holdings in the portfolio company. The current API matches the cap table views in the Carta app, seen below.

Does the Get Capitalization Table API include fund of funds?

No, at this time the API and underlying cap table sharing does not support visibility for fund of funds.

Does the permission level to the cap table (basic, intermediate, or advanced) change the data sent?

The API response data structure does not change based on permission level. Firms will get an access denied error if you didn’t have at least basic cap table access for a particular investment.

How are non-Carta paper companies represented in the Capitalization Table APIs?

Non carta companies will have the same response and follow the same permission logic as Carta companies. The List Cap Table endpoint has a type field which indicates whether the cap table is PRIMARY (Carta company) or PRO_FORMA (non-Carta paper company).

How are converted shares represented in the Capitalization Table APIs?

The fullyDilutedShares counts have the conversion ratios applied to them.

Issuer & Portfolio APIs

Do the Certificates APIs include cancelled certificates?

Yes, and we have a canceledDate field in the API response to indicate these certificates.

Are the details of transfers between two stakeholders noted in the Securities APIs?

No, these types of security transfers are not currently supported.

Does the Portfolio API include FMV values?

We currently expose an exerciseFairMarketValue field within the optionGrantTransactionDetail object in the Portfolio - List Security Transactions API for security transactions. We have similar FMV fields for share and RSU transactions.

How are converted stock splits represented in the Issuer and Portfolio Securities?

After stock splits, old vesting event identifiers will be removed and replaced with new, post-split vesting events. The security quantity values will be updated accordingly as well.

What is the difference between grantExpirationDate and lastExercisableDate for options?

The grantExpirationDate field is the lifetime expiration of the security that is set at the time of issuance. HWhen a security is terminated or expires, the lastExercisableDate is updated accordingly to represent when the stakeholder’s ability to exercise the security expires.

Do partially canceled equity grants include a canceledDate in the API response?

No, a canceledDate would be returned only for the completely canceled grants. The partial cancellation acts on the vesting schedule by sending some of the shares back to the pool, and is not treated as an actual cancellation of the security.

Go-to-market

Which Carta logos should I use within my app?

Please reference this link for Carta's approved in-app marketing assets.

I'm ready to access production APIs. How can I get access?

We have a list of requirements and instructions for receiving production access.

Support

Need help or have feedback? Use one of the below channels to contact our team.

Submit a support ticket

Send an email to [email protected]

Submit an new feature request