Offerings

Get offerings

get
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault: 1
limitnumber · nullableOptionalDefault: 10
includestringOptionalExample: account,issuer,trades,assets,disbursements,draftVersion,publishedVersion,revisions,onboardingReviewedBy,bankAccount,escrowAccount
issuerNamestringOptional
namestringOptional
accountIdstringOptionalExample: account_01j1xgme5qeqq97gpdztd7e4a6
issuerIdanyOptional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
enabledbooleanOptional
managedBystring · enumOptionalPossible values:
versioningTypestring · enumOptionalPossible values:
combinedStatusstring · enumOptionalPossible values:
onboardingStatusstring · enumOptionalPossible values:
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/offerings

[ADMIN] Create offering

post
Authorizations
X-API-KEYstringRequired
Body
issuerIdstringRequiredExample: issuer_01j1xgme...
namestring · min: 2 · max: 100RequiredExample: Airbnb IPO
typestring · enumRequiredExample: REG_DPossible values:
targetAmountnumber · min: 0.01 · max: 10000000000RequiredExample: 120000
raiseAmountnumber · max: 10000000000OptionalExample: 200000
minInvestmentnumber · max: 10000000000OptionalExample: 1000
maxInvestmentnumber · max: 10000000000OptionalExample: 20000
contingencyAmountnumber · max: 10000000000OptionalExample: 5000
startAtstring · nullableOptionalExample: 10/20/2024
endAtstring · nullableOptionalExample: 10/27/2024
activebooleanOptionalExample: true
cancellationPeriodnumber · min: 1 · max: 30 · nullableOptionalExample: 4
descriptionstring · min: 1 · max: 1000 · nullableOptionalExample: This is a description of the offering.
managedBystring · enumOptionalPossible values:
assetNamestring · min: 2 · max: 50RequiredExample: Asset name
assetTypestring · enumRequiredExample: STOCKPossible values:
pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableRequiredExample: 2000
totalUnitsnumber · min: 1 · max: 10000000000 · nullableRequiredExample: 5200
yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample: 1200
durationnumber · min: 1 · max: 1000 · nullableOptionalExample: 1
durationTypestring · enum · nullableOptionalExample: DAYSPossible values:
templatestring · enumOptionalDefault: STANDARDExample: STANDARDPossible values:
tiersnumber[] · nullableOptional
enableBonusbooleanOptionalDefault: false
hasEscrowbooleanOptional
bankAccountIdany · nullableOptional
escrowAccountIdany · nullableOptional
principalAmountinteger · max: 10000000000 · nullableOptionalExample: 1000
maxTotalRaiseinteger · max: 10000000000 · nullableOptionalExample: 100
interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample: 10
interestTypestring · enum · nullableOptionalExample: SIMPLEPossible values:
Responses
post
/clients/api/v1/offerings

Get offerings summary

get
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault: 1
limitnumber · nullableOptionalDefault: 10
accountIdstringOptionalExample: account_01j1xgme5qeqq97gpdztd7e4a6
hasPendingTradesboolean · nullableOptional
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/offerings/summary

Get offering by id

get
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Query parameters
includestringOptionalExample: account,issuer,trades,assets,disbursements,draftVersion,publishedVersion,revisions,onboardingReviewedBy,bankAccount,escrowAccount
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/offerings/{id}

Update offering by id

patch
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
namestring · min: 2 · max: 100OptionalExample: Airbnb IPO
typestring · enumOptionalExample: REG_DPossible values:
targetAmountnumber · max: 10000000000OptionalExample: 120000
minInvestmentnumber · max: 10000000000 · nullableOptionalExample: 1000
maxInvestmentnumber · max: 10000000000 · nullableOptionalExample: 20000
contingencyAmountnumber · max: 10000000000 · nullableOptionalExample: 5000
startAtstring · nullableOptionalExample: 10/20/2024
endAtstring · nullableOptionalExample: 10/27/2024
cancellationPeriodnumber · min: 1 · max: 30 · nullableOptionalExample: 4
descriptionstring · min: 1 · max: 1000 · nullableOptionalExample: This is a description of the offering.
memorandumIdany · nullableOptional
subscriptionAgreementIdany · nullableOptional
coverArtIdany · nullableOptional
showTotalRaisedbooleanOptional
issuerIdstringOptionalExample: issuer_01j1xgme...
assetNamestring · min: 2 · max: 50OptionalExample: Z
assetTypestring · enumOptionalExample: STOCKPossible values:
pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample: 2000
totalUnitsnumber · min: 1 · max: 10000000000 · nullableOptionalExample: 5200
yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample: 1200
durationnumber · min: 1 · max: 1000 · nullableOptionalExample: 1
durationTypestring · enum · nullableOptionalExample: DAYSPossible values:
templatestring · enum · nullableOptionalDefault: STANDARDExample: STANDARDPossible values:
tiersnumber[] · nullableOptional
enabledbooleanOptional
enableBonusbooleanOptional
hasEscrowbooleanOptional
escrowAgreementFileIdany · nullableOptional
bankAccountIdany · nullableOptional
escrowAccountIdany · nullableOptional
principalAmountinteger · max: 10000000000 · nullableOptionalExample: 1000
maxTotalRaiseinteger · max: 10000000000 · nullableOptionalExample: 100
interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample: 10
interestTypestring · enum · nullableOptionalExample: SIMPLEPossible values:
Responses
patch
/clients/api/v1/offerings/{id}

Last updated