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

Xpansiv Exchange API

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 the user to search the current deposits placed on execution venues. The Deposit Creation API allows the user to place inventory on deposit on a target execution venue. The Deposit Withdraw API allows the user to withdraw and place back into inventory deposits held on an execution venue. The Deposit Withdraw and Create Retirements API allows the user to withdraw and retire deposits held on an execution venue. The Deposit Settlement API call would be used to settle executed trades on an execution venue by an execution venue operator.

Xpansiv Exchange API is one of 43 APIs that Xpansiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Exchange. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, a quickstart, and an API reference.

This API exposes 6 operations across 6 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, 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.

6 operations 6 paths 53 schemas 6 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

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.

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

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are TaxLot (14 properties), Retirement (12 properties), BaseInstrument (8 properties), Market (4 properties). Each schema is shown below with its type and property counts.

StateEligibility
object
Object to hold full state eligibility information - type of eligibility, extendable with other information
3 properties
NotAuthorizedError
object
1 property
Market
object
4 properties
Ref.ResourceProjectStatus
string
Ref.Data.RESOURCEPROJECTSTATUS
Ref.WithdrawStatus
string
Status of the deposit withdrawal request. Ref.Data.WITHDRAWSTATUS
Ref.ProjectStatus
string
Ref.Data.PROJECTSTATUS
CarbonInstrument
IssuanceCertification
object
2 properties
Ref.FuelType
string
Ref.Data.RECFUELTYPE
Resource
object
3 properties 1 required
RecInstrument
Ref.RecProgram
string
Ref.Data.RECPROGRAM
Project
Ref.BaselineMethodology
string
Ref.Data.BASELINEMETHODOLOGY
BaseInstrument
object
8 properties 5 required
Ref.Country
string
Ref.Data.COUNTRY
Ref.ResourceOutType
string
Ref.Data.RESOURCEOUTPUTTYPE
Price
object
2 properties 2 required
Ref.RetirementProgramCode
string
Retirement program code. Ref.Data.RETIREMENTPROGRAM
Ref.ProjectType
string
The project type. Ref.Data.CARBONPROJECTTYPE
Ref.ResourceInType
string
Ref.Data.RESOURCEINPUTTYPE
Vintage
object
2 properties 1 required
Ref.Program
string
Ref.Data.PROGRAM
Ref.Currency
string
Ref.Data.CURRENCY
Ref.DepositStatus
string
The current status of the deposit in relation to the execution venue. Ref.Data.DEPOSITSTATUS
Instrument
ResourceProject
Ref.ResourceProgram
string
Ref.Data.RESOURCEPROGRAM
Ref.StateEligibilityType
string
The type of the state eligibility. Ref.Data.RECSTATEELIGIBILITY
Ref.RetirementStatus
string
Status of the retirement. Ref.Data.RETIREMENTSTATUS
FuelType
object
3 properties
InternalServerError
object
1 property
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
MarketModelInstrument
object
3 properties
Ref.ProjectRegistryStatus
string
The registry status of the project. Ref.Data.PROJECTREGISTRYSTATUS
ResourceInstrument
Ref.CarbonProgram
string
Ref.Data.CARBONPROGRAM
Generator
Ref.StateProvince
string
Ref.Data.STATEPROVINCE
NotFoundError
object
1 property
InstrumentMarket
object
2 properties
ProjectCertification
object
2 properties
Ref.VoluntaryEligibilityType
string
The type of the voluntary eligibility. Ref.Data.RECVOLUNTARYELIGIBILITY
Ref.CreditType
string
The type of the credit. Ref.Data.CARBONCREDITTYPE
Ref.ExecutionVenue
string
Ref.Data.EXECUTIONVENUE
Ref.GeneratorStatus
string
The status of the generator in the registry. Ref.Data.GENERATORSTATUS
VoluntaryEligibility
object
Object to hold full voluntary eligibility information - type of eligibility, effective date, expiration, extendable with other information
4 properties
Ref.InstrumentType
string
REC or CARBON. Ref.Data.INSTRUMENTTYPE
MarketModelInstrumentPrice
object
3 properties
Location
object
2 properties
Ref.Certification
string
Certification code. Ref.Data.CARBONCERTIFICATION
Retirement
object
12 properties 7 required
ChildResourceProject

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xpansiv-exchange-api-openapi.yml Raw ↑

Other APIs Xpansiv publishes across the network.

Xpansiv Data API
Xpansiv Marketplace FIX API
Xpansiv Account API
Xpansiv Building types API
Xpansiv Clean Transportation API
Xpansiv Corporate Entity API
Xpansiv Facilities API
Xpansiv Facility import error handling API
Xpansiv File Type V1 API
Xpansiv /file Registry API
Xpansiv Forward Deals API
Xpansiv Generators API
Where this information came from

This is an independent, third-party profile of Xpansiv Exchange 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.