On-ramp a property to Fabrica as a premint, for later minting

post

https://api.fabrica.land/on-ramp/{networkName}/{contractAddress}

This allows for Fabrica to perform async research and preparation required to be completed before a token can be minted

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contractAddress

string

required

networkName

string

enum

required

Allowed:

Body Params

string

^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

The email address of the person minting the token

walletAddress

string

^0x[a-fA-F0-9]{40}$

The wallet address of the person minting the token

country

string

[A-Z]{2}([-_][A-Z0-9]{2})?

The ISO-3166-1 (two-letter country code) or ISO-3166-2 (with 2 or 3 upercase letter or numeric subdivision code after a hyphen), of the property

adminId

string

^[0-9]+$

A positive integer string (leading zeroes allowed): in the US, this is the county FIPS code

propertyId

string

length ≥ 1

In the US, this is the parcel number, or APN

lat

number

The latitude of the property

lon

number

The longitude of the property

geoJson

string

The boundary shape of the property: if left out, will be retrieved from the vendor

acres

number

The total area of the land parcel, in acres

region

string | null

The region of the property (state name in the US

regionCode

string | null

The region code of the property (two-letter state abbreviation in the US

postCode

string | null

The postal code of the property (the zip code in the US

district

string | null

The district of the property (the county in the US

place

string | null

The place of the property (the town or city name in the US

locality

string | null

The locality of the property (the village name in the US

neighborhood

string | null

The name of the neighborhood of the property

street

string | null

The name of the street of the property

address

string | null

The full address of the property

name

string | null

A preferred name for the property, supplied by partners or owners

vendor

string

enum

The vendor used to lookup the value; correlates with vendorId

Allowed:

vendorId

string

length ≥ 1

The ID of the property at the vendor specified in vendor

partner

string

enum

The partner that originated this listing; correlates with partnerId

Allowed:

partnerId

string

length ≥ 1

The ID of the property at the partner specified in partner

clientInput

string

length ≥ 1

The input-box content the web-site visitor accepted when searching for the property

recipients

object

A map of Ethereum addresses to how much supply of the token should be allocated to each address

collectedFields

object

legalDescription

string | null

.*\S.*

The legal description of the property: if left out, it will be looked up in DataTree. Pass null to explicitly clear.

userDescription

string

length ≥ 1

.*\S.*

A marketing description for the property: if left out, we will use AI to generate one

media

array of objects

A list of images and videos to include in the property's configuration

media

documents

array of objects

A list of documents to include in the property's configuration

documents

campaign

string | null

campaignUuid

uuid | null

grantors

array of objects

length ≥ 1

grantors

Response

201