How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Xpansiv

Xpansiv Connect API

Xpansiv Connect exposes environmental commodity account, portfolio, exchange, forward deal, issuance, project, reference data, report, retirement, split lot and transfer operations over REST. Bearer tokens are issued by the Xpansiv authorization server at auth.xpansiv.com.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 28 operations across 28 paths, organized into 14 resource areas, and defines 97 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0-beta.

Requests are made against 3 base URLs: https://sandbox.preprod.connect.xpansiv.com/app/api/v1, https://uat.preprod.connect.xpansiv.com/app/api/v1, https://connect.xpansiv.com/app/api/v1.

28 operations 28 paths 97 schemas 6 GET22 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0-beta
Base URL
https://connect.xpansiv.com/app/api/v1
Authentication
HTTP Bearer
Resource Areas
14

Authentication & Security 1

Xpansiv Connect API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerToken). By default, every request must be authenticated.

Paths & Operations 28

Across 28 paths, the API surfaces 28 operations — 6 GET, 22 POST. They span 14 resource areas, including ReferenceData, Account, AccountHolders, Exchange, Portfolio, Reports, Retirements, Generators, and 6 more. Each is listed below with its method, path, parameters, and response codes.

ReferenceData 1

The Reference Data API enables discovering Xpansiv Connect reference data types and values.

GET
/reference-data
Retrieve list of reference data
getReferenceData → 200401500
Account 2

The Account API allows uses of Xpansiv Connect to pull a list of their registry sub-accounts. As related to the retirement activity, the list reflects the retirement sub-accounts…

GET
/account/{AccountIdentifier}/program/{ProgramCode}/subaccounts
Get sub-accounts
getSubAccountsByProgram 2 params → 200400401500
GET
/account/{AccountIdentifier}
Search for account
accountSearch 2 params → 200400401500
AccountHolders 1
POST
/account-holders/action/search
Account Holders search
searchAccountHolders 2 params body → 200400401500
Exchange 6

The Exchange APIs allow users to take various actions, both read and write, for their interactions with execution venues, such as the CBL platform. The Search Deposits API allows…

POST
/exchanges/{ExchangeCode}/accounts/{AccountIdentifier}/action/search-deposits
Search deposits
searchDeposits 2 params → 200400401404500
POST
/exchanges/{ExchangeCode}/execution-venues/{ExecutionVenueCode}/accounts/{AccountIdentifier}/action/deposit
Deposits creation
deposit 3 params body → 200400401404500
POST
/exchanges/{ExchangeCode}/accounts/{AccountIdentifier}/action/withdraw
Deposits withdraw
withdraw 2 params body → 200400401404500
POST
/exchanges/{ExchangeCode}/account/{AccountIdentifier}/program/{RetirementProgramCode}/action/withdraw-and-retire
Withdraw credits and create retirements
withdrawAndRetire 3 params body → 200400401500
POST
/exchanges/{ExchangeCode}/account/{AccountIdentifier}/program/{ProgramCode}/action/withdraw-and-export
Withdraw credits and create exports
withdrawAndExport 3 params body → 200400401500
POST
/exchanges/{ExchangeCode}/execution-venues/{ExecutionVenueCode}/action/settle
Deposits settlement
settle 2 params body → 201400401404500
Portfolio 2

The Portfolio API allows the user to search their credit inventory (tax lot) data on active positions across all registry accounts linked to their Xpansiv Connect account and/or o…

POST
/portfolio/account/{AccountIdentifier}/position/action/search
Search account positions
searchAccountPositions 4 params body → 200400401500
GET
/portfolio/account/{AccountIdentifier}/actions
Get portfolio account actions
getPortfolioAccountActions 1 param → 200400401500
Reports 1

The Reports API allows the user to retrieve a comprehensive credit inventory (aka Tax Lot by Program Report) on all active positions with a single call across all registry account…

GET
/reports/account/{AccountIdentifier}/type/tax-lots-by-program
Get tax lots by program report
taxLotsByProgramReport 2 params → 200401500
Retirements 4

The Retirements APIs allow users to take various actions, both read and write, for their retirement activity. The Create Retirements API allows users of Xpansiv Connect to retire…

POST
/retirements/account/{AccountIdentifier}/action/check-status
Check retirements status
checkStatus 1 param body → 200400401500
POST
/retirements/account/{AccountIdentifier}/action/search
Search retirements
searchRetirements 2 params body → 200400401404500
POST
/retirements/account/{AccountIdentifier}/program/{RetirementProgramCode}/action/create
Create retirements
createRetirement 2 params body → 200400401500
GET
/retirements/program/{RetirementProgramCode}/rules
Get registry rules
getRegistryRules 1 param → 200401404500
Generators 1
POST
/generators/action/search
Generators search
searchGenerators 3 params body → 200400401500
Projects 1

The Project API allows the user to pull publicly available information about carbon projects registered in the registries that are integrated with Xpansiv Connect. Note - this cal…

POST
/projects/action/search
Projects search
searchProjects 3 params body → 200400401500
Instruments 1
POST
/instruments/action/search
Instruments search
searchInstruments 3 params body → 200400401500
Transfers 5

The Transfers APIs allow users to take various actions, both read and write, for their bilateral transaction activity. The Search Transfers API allows the user to search registry…

POST
/transfers/account/{AccountIdentifier}/action/search
Search transfers
searchTransfers 4 params body → 200400401500
POST
/transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/create
Create transfers
createTransfers 2 params body → 200400401500
POST
/transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/cancel
Cancel transfers
cancelTransfers 2 params body → 200400401500
POST
/transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/reject
Reject transfers
rejectTransfers 2 params body → 200400401500
POST
/transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/accept
Accept transfers
acceptTransfers 2 params body → 200400401500
Issuances 1

The Issuance API allows the user to pull information on any Issuances associated with their account, or permissioned account, for the various registries they are linked with. The…

POST
/issuances/account/{AccountIdentifier}/action/search
Search issuances
searchIssuances 4 params body → 200400401500
Split Lots 1

The Split Lots API allows the user to search split lot data on their Xpansiv Connect account and/or other Xpansiv Connect accounts that have granted your user that access.

POST
/split-lots/account/{AccountIdentifier}/action/search
Search split lots
searchSplitLots 3 params body → 200400401500
Forward Deals 1

The Forward Deals API allows the user to search The Forward Deals associated with their Xpansiv Connect account and/or other Xpansiv Connect accounts that have granted their user…

POST
/forward-deals/account/{AccountIdentifier}/action/search
Search forward deals
searchForwardDeals 4 params body → 200400401500

Schemas 97

The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are TaxLot (14 properties), Retirement (12 properties), CustodianAccountServiceAttributes (9 properties), Account (9 properties). Each schema is shown below with its type and property counts.

NotAuthorizedError
object
1 property
NotFoundError
object
1 property
InternalServerError
object
1 property
Ref.CarbonProgram
string
Ref.Data.CARBONPROGRAM
Ref.RegistryLinkStatus
string
Ref.Data.REGISTRYLINKSTATUS
Ref.AccountStatus
string
Ref.Data.ACCOUNTSTATUS
Ref.ServiceType
string
Ref.Data.SERVICETYPE
Ref.ServiceStatus
string
Ref.Data.SERVICEACCOUNTSTATUS
Ref.OrganizationLegalStructure
string
Ref.Data.ORGANIZATIONLEGALSTRUCTURE
Ref.OrganizationType
string
Ref.Data.ORGANIZATIONTYPE
Ref.CustodianProgram
string
Ref.Data.CUSTODIANPROGRAM
Ref.Program
string
Ref.Data.PROGRAM
Ref.RecProgram
string
Ref.Data.RECPROGRAM
Account
object
9 properties 9 required
AccountRegistryLink
object
5 properties 4 required
Organization
object
4 properties 3 required
AccountService
object
Canonical account service response (id, status, type, optional attributes). Used on Account.services and on standalone service-account endpoints. Polymorphism…
4 properties 3 required
AccountServiceAttributes
Shape is determined by the parent service type (Ref.ServiceType), using mapping: ACX → AcxAccountServiceAttributes; SUBACCOUNTSERVICE → SubaccountAccountServic…
AcxAccountServiceAttributes
object
Attributes for account service with type ACX.
1 property 1 required
RetirementSubaccountCode
object
List of retirement subaccounts
3 properties 2 required
SubaccountAccountServiceAttributes
object
Attributes for account service with type SUBACCOUNTSERVICE.
4 properties 2 required
CustodianAccountServiceAttributes
object
Attributes for account service with type CUSTODIANSERVICE.
9 properties 3 required
Page
object
4 properties 4 required
Location
object
2 properties
Ref.ExecutionVenue
string
Ref.Data.EXECUTIONVENUE
Ref.Currency
string
Ref.Data.CURRENCY
Ref.Country
string
Ref.Data.COUNTRY
Ref.FuelType
string
Ref.Data.RECFUELTYPE
Ref.StateProvince
string
Ref.Data.STATEPROVINCE
Ref.Certification
string
Certification code. Ref.Data.CARBONCERTIFICATION
Ref.CreditType
string
The type of the credit. Ref.Data.CARBONCREDITTYPE
Ref.ProjectType
string
The project type. Ref.Data.CARBONPROJECTTYPE
Ref.BaselineMethodology
string
Ref.Data.BASELINEMETHODOLOGY
Ref.GeneratorStatus
string
The status of the generator in the registry. Ref.Data.GENERATORSTATUS
Ref.ForwardDealStatus
string
Ref.Data.FORWARDDEALSTATUS
Ref.TransactionSideType
string
Buy or Sell. Ref.Data.FORWARDDEALTRANSACTIONTYPE
Ref.VintageType
string
Ref.Data.FORWARDDEALVINTAGETYPE
Ref.UnitOfMeasure
string
Unit of measure. Ref.Data.UNITOFMEASURE
Ref.ForwardTransactionQuantityType
string
Quantity type. Ref.Data.FORWARDDEALQUANTITYTYPE
Ref.ForwardTransactionStatus
string
Delivery status. Ref.Data.FORWARDDEALTRANSACTIONSTATUS
Ref.ForwardDeliveryScheduleType
string
Delivery schedule type. Ref.Data.FORWARDDEALDELIVERYSCHEDULETYPE
Ref.ResourceInType
string
Ref.Data.RESOURCEINPUTTYPE
Ref.ResourceOutType
string
Ref.Data.RESOURCEOUTPUTTYPE
Ref.InstrumentType
string
REC or CARBON. Ref.Data.INSTRUMENTTYPE
Ref.SubAccountType
string
Type of registry sub-account. Ref.Data.SUBACCOUNTREGISTRYTYPE
Ref.ComplianceStatus
string
Flag for whether sub-account is for compliance retirement activity. Ref.Data.COMPLIANCESTATUS
Ref.WithdrawStatus
string
Status of the deposit withdrawal request. Ref.Data.WITHDRAWSTATUS
Ref.ForwardDealType
string
Type of deal as either Market or Project Specific. Ref.Data.FORWARDDEALTYPE
Ref.TaxLotSelectionStrategy
string
Ref.Data.TAXLOTSELECTIONSTRATEGY
Ref.ProjectRegistryStatus
string
The registry status of the project. Ref.Data.PROJECTREGISTRYSTATUS
Price
object
2 properties 2 required
Vintage
object
2 properties 1 required
Position
object
4 properties
TaxLot
object
A Tax Lot represents the incoming activity that resulted in the creation or increase of a position against an EIN. The types of activities represented by Tax L…
14 properties
Retirement
object
12 properties 7 required
Ref.RetirementProgramCode
string
Retirement program code. Ref.Data.RETIREMENTPROGRAM
Ref.RetirementStatus
string
Status of the retirement. Ref.Data.RETIREMENTSTATUS
Resource
object
3 properties 1 required
Ref.ResourceProgram
string
Ref.Data.RESOURCEPROGRAM
Ref.ResourceProjectStatus
string
Ref.Data.RESOURCEPROJECTSTATUS
AccountHolder
object
7 properties 4 required
Generator
FuelType
object
3 properties
StateEligibility
object
Object to hold full state eligibility information - type of eligibility, extendable with other information
3 properties
VoluntaryEligibility
object
Object to hold full voluntary eligibility information - type of eligibility, effective date, expiration, extendable with other information
4 properties
Ref.StateEligibilityType
string
The type of the state eligibility. Ref.Data.RECSTATEELIGIBILITY
Ref.VoluntaryEligibilityType
string
The type of the voluntary eligibility. Ref.Data.RECVOLUNTARYELIGIBILITY
Ref.ProjectStatus
string
Ref.Data.PROJECTSTATUS
Project
ProjectCertification
object
2 properties
IssuanceCertification
object
2 properties
ResourceProject
ChildResourceProject
BaseInstrument
object
8 properties 5 required
CarbonInstrument
RecInstrument
ResourceInstrument
Instrument
MarketModelInstrumentPrice
object
3 properties
MarketModelInstrument
object
3 properties
InstrumentMarket
object
2 properties
Market
object
4 properties
Ref.DepositStatus
string
The current status of the deposit in relation to the execution venue. Ref.Data.DEPOSITSTATUS
Ref.TransferStatus
string
Ref.Data.TRANSFERSTATUS
Ref.RegistryTransferStatus
string
Ref.Data.TRANSFERREGISTRYSTATUS
Ref.TransferType
string
Ref.Data.TRANSFERACTIONTYPE
Ref.RegistryTransferPurpose
string
Ref.Data.PJMTRANSFERPURPOSE
TransferDataStrategy
object
3 properties 3 required
TransferDataTaxLots
object
2 properties 2 required
PortfolioAction
object
5 properties
ForwardContract
object
3 properties
ForwardInstrumentAttributeBundle
object
2 properties
ForwardInstrumentMarketModelInstrument
object
2 properties
ForwardDateRange
object
4 properties
ForwardMarket
object
2 properties
ForwardFuelType
object
2 properties
ForwardStatusEvent
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xpansiv-connect-openapi.yml Raw ↑
#Carbon Markets#Retirements#Portfolio
← Back to X APIs
API Details
ID
xpansiv:xpansiv-connect-api
Base URL
https://connect.xpansiv.com/app/api/v1
Docs
https://developer.xpansiv.com/developer-portal/xpansiv-connect
Provider
Xpansiv
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=xpansiv-xpansiv-connect-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/xpansiv-xpansiv-connect-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Xpansiv Connect API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.