> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trusset.org/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Deployment Options
> Read the choices and limits that apply before deploying a market
Returns what a deployment on this instance can choose and what the factory fixes, before any calldata is built. Read it before [Deploy Market](/endpoints/lending/deploy-market). It carries the factory's live rate ceiling and the fixed fee shares. It also carries the ranges the term offering accepts and the identity register this instance resolves to.
Most of the answer is fixed by the contracts and the backend, and is returned so a deployment form does not hard-code it. Three values are read live from the factory: `creatorRateCeilingBps` and the two share `bps` figures. A factory that cannot be read answers `null` in those fields rather than failing the request.
## Response Fields
The lending factory this instance deploys to.
Factory address, lowercased. `null` when no factory is configured for this network.
Whether the factory accepts markets offered beyond their named candidates. `null` when no factory is configured.
The highest floor, cap or fixed rate a deployment may carry, in basis points. `null` when the factory could not be read.
`NAV`, `MARKET` and `ORACLE`.
`NAV`.
`true`. A `MARKET` deployment must name a borrower register.
`false`, for the same reason.
`true`. An `ORACLE` deployment must name its feed in `oracleAddress`.
`true`. An `ORACLE` market takes its first price from the feed, so it takes no `initialPrice`.
How the market's two registers behave. See [Get Identity Gates](/endpoints/lending/get-identity-gates).
Price sources that require a borrower register: `["MARKET"]`.
`false`. A provider register admits nobody to deposit directly into the market.
`true`. Every vault registered on the market examines its depositors against the provider register before it routes their money in.
`true`.
`true`. The market admin can change both registers after adoption.
The answers to `isVerified(address)` a register may give: `bool` or `tuple`.
`CURVE`, `CLAMPED` and `FIXED`.
`CURVE`.
The same ceiling as under `factory`.
`true`. A `FIXED` deployment needs `maxLoanDurationDays`.
`false`. A binding `CLAMPED` cap holds the rate at the cap and blocks nothing.
The share of repaid interest paid to the wallet that takes the lender-of-record role.
`true`. The factory holds it as a constant.
The share in basis points, read from the factory. `null` when it could not be read.
`true`. The share is taken from the interest left after the Trusset infrastructure fee.
`false`. A deployment that sends `operatorShareBps` is refused.
The share of repaid interest paid to distributors.
`true`.
The share in basis points, read from the factory. `null` when it could not be read.
`true`.
Who receives it: the distributors behind each vault depositor, and the operator for liquidity no distributor brought.
`OPERATOR_WALLET` and `REGISTERED_VAULTS`. A current market accepts direct deposits from these two alone.
`true`. Everyone else provides liquidity through a vault.
`[1, 3650]`.
`[1, 30]`.
`3`, applied when terms are on and no grace period is named.
`true`. A term change reaches loans opened afterwards only.
The identity register this instance resolves to. Nothing installs it on a market by default. A deployment or an adoption uses it only when it names it.
`TRUSSET` when the instance uses the Trusset register, `OWN` when it configured its own.
That register's address, lowercased. `null` when it could not be resolved.
Why the register could not be resolved, for example an `OWN` mode with no address configured. `null` otherwise.
```bash cURL theme={null}
curl "https://api.trusset.org/lending-external-securities-v2/api/markets/deployment-options" \
-H "X-API-Key: trusset_your_key_here"
```
```typescript TypeScript theme={null}
const res = await fetch(
'https://api.trusset.org/lending-external-securities-v2/api/markets/deployment-options',
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
const ceiling = data.rateOffering.creatorRateCeilingBps;
```
```json Response theme={null}
{
"success": true,
"data": {
"factory": {
"address": "0xf1ad12f5698f58badd8a662acffccb067a2ddb8a",
"openToAnyCurator": true,
"creatorRateCeilingBps": 50000
},
"priceSources": {
"options": ["NAV", "MARKET", "ORACLE"],
"default": "NAV",
"marketRequiresIdentityRegistry": true,
"identityRegistryAlwaysOptional": false,
"oracleRequiresFeedAddress": true,
"oracleInitialPriceFromFeed": true
},
"identityGates": {
"borrowerGateRequiredFor": ["MARKET"],
"providerGateOpensPool": false,
"providerGateReadByVaults": true,
"poolClosedWithoutProviderGate": true,
"adjustableByAdmin": true,
"acceptedShapes": ["bool", "tuple"]
},
"rateOffering": {
"modes": ["CURVE", "CLAMPED", "FIXED"],
"default": "CURVE",
"creatorRateCeilingBps": 50000,
"fixedRequiresTerms": true,
"capSuspendsBorrows": false
},
"operatorShare": {
"fixed": true,
"bps": 800,
"afterInfrastructureFee": true,
"acceptedAtDeployment": false
},
"distributorShare": {
"fixed": true,
"bps": 500,
"afterInfrastructureFee": true,
"paidTo": "the distributors behind each vault depositor, the operator for liquidity no distributor brought"
},
"liquidity": {
"directDepositors": ["OPERATOR_WALLET", "REGISTERED_VAULTS"],
"thirdPartiesThroughVaults": true
},
"termOffering": {
"maxLoanDurationDaysRange": [1, 3650],
"termGracePeriodDaysRange": [1, 30],
"graceDefaultDays": 3,
"newLoansOnly": true
},
"identityRegistry": {
"mode": "TRUSSET",
"instanceRegister": "0x9e3c8a15f4d70b2681c5a3f9027d4be8115c7d21",
"unavailableReason": null
}
}
}
```
## Error Codes
This endpoint has no refusals of its own beyond authentication, rate limiting and credits. Unreadable factory values come back as `null` instead of an error.