# Xpansiv Connect API This is the OpenAPI spec for Xpansiv Connect API. Documentation: https://developer.xpansiv.com/developer-portal/ Version: 1.0.0-beta ## Servers SANDBOX ``` https://sandbox.preprod.connect.xpansiv.com/app/api/v1 ``` UAT ``` https://uat.preprod.connect.xpansiv.com/app/api/v1 ``` PROD ``` https://connect.xpansiv.com/app/api/v1 ``` ## Security ### bearerToken Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Xpansiv Connect API](https://developer.xpansiv.com/_bundle/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi.yaml) ## Account 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 which are required when executing retirements in specific registries or when searching retirement history. The registries with data to return for this call are NEPOOL, M_RETS, NAR, MIRECS, NCRETS, NYGATS, TIGR, CAR, VCS, ACR, RMS AND TERCS. ### Get sub-accounts - [GET /account/{AccountIdentifier}/program/{ProgramCode}/subaccounts](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/account/getsubaccountsbyprogram.md): Get sub-accounts for a given account and program ## Exchange 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 Get Accounts API allows the user to pull their active accounts, and the programs associated with those accounts, linked with the execution venue. 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. ### Get accounts - [GET /exchanges/{ExchangeCode}/accounts](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/exchange/getexchangeaccounts.md): List of accounts subscribed to an exchange ### Search deposits - [POST /exchanges/{ExchangeCode}/accounts/{AccountIdentifier}/action/search-deposits](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/exchange/searchdeposits.md): Get list of deposits for an exchange ### Deposits creation - [POST /exchanges/{ExchangeCode}/execution-venues/{ExecutionVenueCode}/accounts/{AccountIdentifier}/action/deposit](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/exchange/deposit.md): Deposits creation ### Deposits withdraw - [POST /exchanges/{ExchangeCode}/accounts/{AccountIdentifier}/action/withdraw](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/exchange/withdraw.md): Deposits withdraw ### Withdraw credits and create retirements - [POST /exchanges/{ExchangeCode}/account/{AccountIdentifier}/program/{RetirementProgramCode}/action/withdraw-and-retire](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/exchange/withdrawandretire.md): Allows the combination of withdrawal of credits and creation of retirements in bulk ### Withdraw credits and create exports - [POST /exchanges/{ExchangeCode}/account/{AccountIdentifier}/program/{ProgramCode}/action/withdraw-and-export](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/exchange/withdrawandexport.md): Allows the combination of withdrawal of credits and creation of export in bulk ### Deposits settlement - [POST /exchanges/{ExchangeCode}/execution-venues/{ExecutionVenueCode}/action/settle](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/exchange/settle.md): Deposits settlement ## Forward Deals 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 that access. Forward Deal information is returned based on a Deal's last updated date. Note that this call has a number of optional fields that the users needs to include if desired in the output. ### Search forward deals - [POST /forward-deals/account/{AccountIdentifier}/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/forward-deals/searchforwarddeals.md) ## Issuances 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 Instrument details on the Issuance will be returned in the format of a Carbon Instrument (type CARBON) or a REC Instrument (type REC) as appropriate. Each of the types are returned with data specific to the Carbon or REC attributes. ### Search issuances - [POST /issuances/account/{AccountIdentifier}/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/issuances/searchissuances.md) ## Portfolio 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 other Xpansiv Connect accounts that have granted their user that access. Note that This call has a number of optional fields that the user needs to include if desired in the output. ### Search account positions - [POST /portfolio/account/{AccountIdentifier}/position/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/portfolio/searchaccountpositions.md) ### Get portfolio account actions - [GET /portfolio/account/{AccountIdentifier}/actions](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/portfolio/getportfolioaccountactions.md) ## Projects 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 call has a number of optional fields that the user needs to include if desired in the output. ### Projects search - [POST /projects/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/projects/searchprojects.md) ## ReferenceData The Reference Data API enables discovering Xpansiv Connect reference data types and values. ### Retrieve list of reference data - [GET /reference-data](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/referencedata/getreferencedata.md) ## Reports 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 accounts linked to their Xpansiv Connect account or other Xpansiv Connect accounts that have granted their user that access. Note - this call has a number of optional fields that the user needs to include if desired in the output. ### Get tax lots by program report - [GET /reports/account/{AccountIdentifier}/type/tax-lots-by-program](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/reports/taxlotsbyprogramreport.md) ## Retirements 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 one or more positions from their linked registry accounts and/or other Xpansiv Connect accounts that have granted their API user with that access. The Get Registry Rules API call provides the user with the information required to pass the correct rule attributes specific to each registry with each retirement attempt. The Check Retirement Status API allows users to query the status of their retirements. The Search retirements API allows users search their retirement history. Note - this call has a number of optional fields that the user needs to include if desired in the output. ### Check retirements status - [POST /retirements/account/{AccountIdentifier}/action/check-status](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/retirements/checkstatus.md) ### Search retirements - [POST /retirements/account/{AccountIdentifier}/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/retirements/searchretirements.md): Searches for all retirements for given program and/or between given date range ### Create retirements - [POST /retirements/account/{AccountIdentifier}/program/{RetirementProgramCode}/action/create](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/retirements/createretirement.md): Allows creation retirements in bulk ### Get registry rules - [GET /retirements/program/{RetirementProgramCode}/rules](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/retirements/getregistryrules.md) ## Split Lots 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. ### Search split lots - [POST /split-lots/account/{AccountIdentifier}/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/split-lots/searchsplitlots.md) ## Transfers 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 transfer data for their Xpansiv Connect account and/or other Xpansiv Connect accounts that have granted your user that access. Note - this call has a number of optional fields that the user needs to include if desired in the output. The Create Transfers API allows the user to create new bilateral transfers. The Cancel Transfers API allows the user to cancel/withdrawal any pending outgoing transfers. The Reject Transfers API allows the user to reject any pending incoming transfer. The Accept Transfers API allows the user to accept any pending incoming transfer. ### Search transfers - [POST /transfers/account/{AccountIdentifier}/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/transfers/searchtransfers.md) ### Create transfers - [POST /transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/create](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/transfers/createtransfers.md): Allows creation transfers in bulk ### Cancel transfers - [POST /transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/cancel](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/transfers/canceltransfers.md): Allows cancellation transfers in bulk ### Reject transfers - [POST /transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/reject](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/transfers/rejecttransfers.md): Allows rejection transfers in bulk ### Accept transfers - [POST /transfers/account/{AccountIdentifier}/program/{ProgramCode}/action/accept](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/transfers/accepttransfers.md): Allows acceptance transfers in bulk ## AccountHolders ### Account Holders search - [POST /account-holders/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/accountholders/searchaccountholders.md) ## Generators ### Generators search - [POST /generators/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/generators/searchgenerators.md) ## Instruments ### Instruments search - [POST /instruments/action/search](https://developer.xpansiv.com/openapi/xpansiv-connect-v1/xpansiv-connect.v1.openapi/instruments/searchinstruments.md)