Offerings
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault:
1limitnumber · nullableOptionalDefault:
10includestringOptionalExample:
account,issuer,trades,assets,disbursements,draftVersion,publishedVersion,revisions,onboardingReviewedBy,bankAccount,escrowAccountissuerNamestringOptional
namestringOptional
accountIdstringOptionalExample:
account_01j1xgme5qeqq97gpdztd7e4a6issuerIdanyOptional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
enabledbooleanOptional
managedBystring · enumOptionalPossible values:
versioningTypestring · enumOptionalPossible values:
combinedStatusstring · enumOptionalPossible values:
onboardingStatusstring · enumOptionalPossible values:
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
get
/clients/api/v1/offeringsAuthorizations
X-API-KEYstringRequired
Body
issuerIdstringRequiredExample:
issuer_01j1xgme...namestring · min: 2 · max: 100RequiredExample:
Airbnb IPOtypestring · enumRequiredExample:
REG_DPossible values: targetAmountnumber · min: 0.01 · max: 10000000000RequiredExample:
120000raiseAmountnumber · max: 10000000000OptionalExample:
200000minInvestmentnumber · max: 10000000000OptionalExample:
1000maxInvestmentnumber · max: 10000000000OptionalExample:
20000contingencyAmountnumber · max: 10000000000OptionalExample:
5000startAtstring · nullableOptionalExample:
10/20/2024endAtstring · nullableOptionalExample:
10/27/2024activebooleanOptionalExample:
truecancellationPeriodnumber · min: 1 · max: 30 · nullableOptionalExample:
4descriptionstring · min: 1 · max: 1000 · nullableOptionalExample:
This is a description of the offering.managedBystring · enumOptionalPossible values:
assetNamestring · min: 2 · max: 50RequiredExample:
Asset nameassetTypestring · enumRequiredExample:
STOCKPossible values: pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableRequiredExample:
2000totalUnitsnumber · min: 1 · max: 10000000000 · nullableRequiredExample:
5200yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
1200durationnumber · min: 1 · max: 1000 · nullableOptionalExample:
1durationTypestring · enum · nullableOptionalExample:
DAYSPossible values: templatestring · enumOptionalDefault:
STANDARDExample: STANDARDPossible values: tiersnumber[] · nullableOptional
enableBonusbooleanOptionalDefault:
falsehasEscrowbooleanOptional
bankAccountIdany · nullableOptional
escrowAccountIdany · nullableOptional
principalAmountinteger · max: 10000000000 · nullableOptionalExample:
1000maxTotalRaiseinteger · max: 10000000000 · nullableOptionalExample:
100interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample:
10interestTypestring · enum · nullableOptionalExample:
SIMPLEPossible values: Responses
201
201
application/json
400
400
application/json
401
401
application/json
403
403
application/json
500
500
application/json
post
/clients/api/v1/offeringsAuthorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault:
1limitnumber · nullableOptionalDefault:
10accountIdstringOptionalExample:
account_01j1xgme5qeqq97gpdztd7e4a6hasPendingTradesboolean · nullableOptional
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
500
500
application/json
get
/clients/api/v1/offerings/summaryAuthorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Query parameters
includestringOptionalExample:
account,issuer,trades,assets,disbursements,draftVersion,publishedVersion,revisions,onboardingReviewedBy,bankAccount,escrowAccountResponses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
get
/clients/api/v1/offerings/{id}Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
namestring · min: 2 · max: 100OptionalExample:
Airbnb IPOtypestring · enumOptionalExample:
REG_DPossible values: targetAmountnumber · max: 10000000000OptionalExample:
120000minInvestmentnumber · max: 10000000000 · nullableOptionalExample:
1000maxInvestmentnumber · max: 10000000000 · nullableOptionalExample:
20000contingencyAmountnumber · max: 10000000000 · nullableOptionalExample:
5000startAtstring · nullableOptionalExample:
10/20/2024endAtstring · nullableOptionalExample:
10/27/2024cancellationPeriodnumber · min: 1 · max: 30 · nullableOptionalExample:
4descriptionstring · 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:
ZassetTypestring · enumOptionalExample:
STOCKPossible values: pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
2000totalUnitsnumber · min: 1 · max: 10000000000 · nullableOptionalExample:
5200yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
1200durationnumber · min: 1 · max: 1000 · nullableOptionalExample:
1durationTypestring · 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:
1000maxTotalRaiseinteger · max: 10000000000 · nullableOptionalExample:
100interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample:
10interestTypestring · enum · nullableOptionalExample:
SIMPLEPossible values: Responses
201
201
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
500
500
application/json
patch
/clients/api/v1/offerings/{id}Last updated