Smarty us-enrichment API

openapi: 3.0.1
info:
  title: International Address Autocomplete Lookup us-enrichment API
  version: '0.9'
  description: "This API returns suggestions that are fully verified global addresses.\nUses fuzzy logic during searching to:\nAllow for missing directionals and street suffixes.\nAllow substitution of street suffixes and unit designators. E.g., ST is accepted for AVE; APT is accepted for UNIT, etc.\nAllow full or partial spelling of street suffixes and unit designators. E.g., ST can be spelled as STR or STREET and still match.\nFilters and preferences allow for multiple cities in a single country.\nNote: Effective with the adoption of the V2 version of International Address Autocomplete, lookup usage will be based on the final selection of an address rather than per keystroke.\n\nBy default, the character set returned will be the native set for that country. If any latin characters are provided in the input (excluding numerics), the latin set will be returned. Character sets include:\nCyrillic\nGreek\nHebrew\nKanji (Japanese)\nSimplified Chinese\nArabic\nThai\nHangul (Korean)\n\nSupports the following 242 countries: \nAfghanistan\tAFG\nAlbania\tALB\nAlgeria\tDZA\nAndorra\tAND\nAngola\tAGO\nAnguilla\tAIA\nAntarctica\tATA\nAntigua and Barbuda\tATG\nArgentina\tARG\nArmenia\tARM\nAruba\tABW\nAustralia\tAUS\nAustria\tAUT\nAzerbaijan\tAZE\nBahamas\tBHS\nBahrain\tBHR\nBangladesh\tBGD\nBarbados\tBRB\nBelarus\tBLR\nBelgium\tBEL\nBelize\tBLZ\nBenin\tBEN\nBermuda\tBMU\nBhutan\tBTN\nBolivia\tBOL\nBonaire, Sint Eustatius and Saba\tBES\nBosnia and Herzegovina\tBIH\nBotswana\tBWA\nBouvet Island\tBVT\nBrazil\tBRA\nBritish Indian Ocean Territory\tIOT\nBrunei Darussalam\tBRN\nBulgaria\tBGR\nBurkina Faso\tBFA\nBurundi\tBDI\nCambodia\tKHM\nCameroon\tCMR\nCanada\tCAN\nCabo Verde\tCPV\nCayman Islands\tCYM\nCentral African Republic\tCAF\nChad\tTCD\nChile\tCHL\nChina\tCHN\nChristmas Island\tCXR\nCocos (Keeling) Islands\tCCK\nColombia\tCOL\nComoros\tCOM\nCongo\tCOG\nDemocratic Republic of the Congo\tCOD\nCook Islands\tCOK\nCosta Rica\tCRI\nCroatia\tHRV\nCuba\tCUB\nCuraçao\tCUW\nCyprus\tCYP\nCzechia\tCZE\nIvory Coast\tCIV\nDenmark\tDNK\nDjibouti\tDJI\nDominica\tDMA\nDominican Republic\tDOM\nEcuador\tECU\nEgypt\tEGY\nEl Salvador\tSLV\nEquatorial Guinea\tGNQ\nEritrea\tERI\nEstonia\tEST\nEswatini\tSWZ\nEthiopia\tETH\nFalkland Islands\tFLK\nFaroe Islands\tFRO\nFiji\tFJI\nFinland\tFIN\nFrance\tFRA\nFrench Guiana\tGUF\nFrench Polynesia\tPYF\nFrench Southern Territories\tATF\nGabon\tGAB\nGambia\tGMB\nGeorgia\tGEO\nGermany\tDEU\nGhana\tGHA\nGibraltar\tGIB\nGreece\tGRC\nGreenland\tGRL\nGrenada\tGRD\nGuadeloupe\tGLP\nGuatemala\tGTM\nGuernsey\tGGY\nGuinea\tGIN\nGuinea-Bissau\tGNB\nGuyana\tGUY\nHaiti\tHTI\nHeard Island and McDonald Islands\tHMD\nHoly See\tVAT\nHonduras\tHND\nHong Kong\tHKG\nHungary\tHUN\nIceland\tISL\nIndia\tIND\nIndonesia\tIDN\nIslamic Republic of Iran\tIRN\nIraq\tIRQ\nIreland\tIRL\nIsle of Man\tIMN\nIsrael\tISR\nItaly\tITA\nJamaica\tJAM\nJapan\tJPN\nJersey\tJEY\nJordan\tJOR\nKazakhstan\tKAZ\nKenya\tKEN\nKiribati\tKIR\nDemocratic People's Republic of Korea (North Korea)\tPRK\nRepublic of Korea\tKOR\nKosovo\tXKX\nKuwait\tKWT\nKyrgyzstan\tKGZ\nLao People's Democratic Republic\tLAO\nLatvia\tLVA\nLebanon\tLBN\nLesotho\tLSO\nLiberia\tLBR\nLibya\tLBY\nLiechtenstein\tLIE\nLithuania\tLTU\nLuxembourg\tLUX\nMacao\tMAC\nRepublic of North Macedonia\tMKD\nMadagascar\tMDG\nMalawi\tMWI\nMalaysia\tMYS\nMaldives\tMDV\nMali\tMLI\nMalta\tMLT\nMartinique\tMTQ\nMauritania\tMRT\nMauritius\tMUS\nMayotte\tMYT\nMexico\tMEX\nFederated States of Micronesia\tFSM\nRepublic of Moldova\tMDA\nMonaco\tMCO\nMongolia\tMNG\nMontenegro\tMNE\nMontserrat\tMSR\nMorocco\tMAR\nMozambique\tMOZ\nMyanmar\tMMR\nNamibia\tNAM\nNauru\tNRU\nNepal\tNPL\nNetherlands\tNLD\nNew Caledonia\tNCL\nNew Zealand\tNZL\nNicaragua\tNIC\nNiger\tNER\nNigeria\tNGA\nNiue\tNIU\nNorfolk Island\tNFK\nNorway\tNOR\nOman\tOMN\nPakistan\tPAK\nPalau\tPLW\nState of Palestine\tPSE\nPanama\tPAN\nPapua New Guinea\tPNG\nParaguay\tPRY\nPeru\tPER\nPhilippines\tPHL\nPitcairn\tPCN\nPoland\tPOL\nPortugal\tPRT\nQatar\tQAT\nSouth Sudan\tSSD\nRomania\tROU\nRussian Federation\tRUS\nRwanda\tRWA\nRéunion\tREU\nSaint Barthélemy\tBLM\nSaint Helena, Ascension and Tristan da Cunha\tSHN\nSaint Kitts and Nevis\tKNA\nSaint Lucia\tLCA\nSaint Martin\tMAF\nSaint Pierre and Miquelon\tSPM\nSaint Vincent and the Grenadines\tVCT\nSamoa\tWSM\nSan Marino\tSMR\nSao Tome and Principe\tSTP\nSaudi Arabia\tSAU\nSenegal\tSEN\nSerbia\tSRB\nSeychelles\tSYC\nSierra Leone\tSLE\nSingapore\tSGP\nSint Maarten (Dutch)\tSXM\nSlovakia\tSVK\nSlovenia\tSVN\nSolomon Islands\tSLB\nSomalia\tSOM\nSouth Africa\tZAF\nSouth Georgia and the South Sandwich Islands\tSGS\nSpain\tESP\nSri Lanka\tLKA\nSudan\tSDN\nSuriname\tSUR\nSvalbard and Jan Mayen Islands\tSJM\nSweden\tSWE\nSwitzerland\tCHE\nSyrian Arab Republic\tSYR\nTaiwan\tTWN\nTajikistan\tTJK\nUnited Republic of Tanzania\tTZA\nThailand\tTHA\nTimor-Leste\tTLS\nTogo\tTGO\nTokelau\tTKL\nTonga\tTON\nTrinidad and Tobago\tTTO\nTunisia\tTUN\nTürkiye (Turkey)\tTUR\nTurkmenistan\tTKM\nTurks and Caicos Islands\tTCA\nTuvalu\tTUV\nUganda\tUGA\nUkraine\tUKR\nUnited Arab Emirates\tARE\nUnited Kingdom\tGBR\nUruguay\tURY\nUzbekistan\tUZB\nVanuatu\tVUT\nBolivarian Republic of Venezuela\tVEN\nViet Nam\tVNM\nBritish Virgin Islands\tVGB\nWallis and Futuna\tWLF\nWestern Sahara\tESH\nYemen\tYEM\nZambia\tZMB\nZimbabwe\tZWE\nÅland Islands\tALA\n"
  termsOfService: https://smartystreets.com/legal/terms-of-service
  license:
    url: https://www.smarty.com/legal/terms-of-service
    name: Smarty License
  contact:
    name: Smarty Support
    email: support@smartystreets.com
servers:
- url: https://international-autocomplete.api.smarty.com
tags:
- name: us-enrichment
paths:
  /lookup/{smartykey}/property:
    get:
      operationId: get-lookup-smartykey-property
      tags:
      - us-enrichment
      summary: Property Lookup by Smartykey
      description: Contains all property data attributes including tax assessor and recorder data. Recorder data will be last available financial transaction for the property. When requesting the financial feature, the result will contain historical financial data pertaining to the property and property owner.
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/smartykey'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      responses:
        '200':
          $ref: '#/components/responses/PropertyResponseSmartyKey'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /lookup/search/property:
    get:
      operationId: get-lookup-property
      tags:
      - us-enrichment
      summary: Property Lookup by Search Fields
      description: Contains all property data attributes including tax assessor and recorder data. Recorder data will be last available financial transaction for the property. When requesting the financial feature, the result will contain historical financial data pertaining to the property and property owner.
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      - $ref: '#/components/parameters/freeform'
      - $ref: '#/components/parameters/street'
      - $ref: '#/components/parameters/city'
      - $ref: '#/components/parameters/state'
      - $ref: '#/components/parameters/zipcode'
      responses:
        '200':
          $ref: '#/components/responses/PropertyResponseSearch'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /lookup/{smarykey}/geo-reference/{dataset?}:
    get:
      operationId: get-lookup-smartykey-geo
      tags:
      - us-enrichment
      summary: US Census Block and Tract Lookup by Smartykey
      description: 'The Census Block and Tract Data product provides useful geographic data for geocoded addresses, such as census block id. Request legacy data, such as the 2010 and 2020 census, by specifying a data subset of 2010 or 2020. For example: To return 2010 census data, specify geo-reference/2010. To request the latest census information available, simply specify geo-reference with no trailing subset. The census version will be returned in the data_set_version property in the response.'
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/smartykey'
      - $ref: '#/components/parameters/dataset'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      responses:
        '200':
          $ref: '#/components/responses/CensusBlockAndTractResponseSmartyKey'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /lookup/search/geo-reference/{dataset?}:
    get:
      operationId: get-lookup-geo
      tags:
      - us-enrichment
      summary: US Census Block and Tract Data Lookup by Search Fields
      description: 'The Census Block and Tract Data product provides useful geographic data for geocoded addresses, such as census block id. Request legacy data, such as the 2010 and 2020 census, by specifying a data subset of 2010 or 2020. For example: To return 2010 census data, specify geo-reference/2010. To request the latest census information available, simply specify geo-reference with no trailing subset. The census version will be returned in the data_set_version property in the response.'
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/dataset'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      - $ref: '#/components/parameters/freeform'
      - $ref: '#/components/parameters/street'
      - $ref: '#/components/parameters/city'
      - $ref: '#/components/parameters/state'
      - $ref: '#/components/parameters/zipcode'
      responses:
        '200':
          $ref: '#/components/responses/CensusBlockAndTractResponseSearch'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /lookup/{smartykey}/secondary:
    get:
      operationId: get-lookup-smartykey-secondary
      tags:
      - us-enrichment
      summary: US Secondary Data Lookup by Smartykey
      description: The secondary data product returns all secondaries and aliases associated with a SmartyKey. The SmartyKey can be that of the root address, any of the aliases, or any of the secondaries. Each will return the same related data.
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/smartykey'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      responses:
        '200':
          $ref: '#/components/responses/SecondaryResponseSmartyKey'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /lookup/search/secondary:
    get:
      operationId: get-lookup-secondary
      tags:
      - us-enrichment
      summary: US Secondary Data Lookup by Search Fields
      description: The secondary data product returns all secondaries and aliases associated with a SmartyKey. Each will return the same related data.
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      - $ref: '#/components/parameters/freeform'
      - $ref: '#/components/parameters/street'
      - $ref: '#/components/parameters/city'
      - $ref: '#/components/parameters/state'
      - $ref: '#/components/parameters/zipcode'
      responses:
        '200':
          $ref: '#/components/responses/SecondaryResponseSearch'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /lookup/{smartykey}/secondary/count:
    get:
      operationId: get-lookup-smartykey-secondary-count
      tags:
      - us-enrichment
      summary: US Secondary Data Lookup by Smartykey
      description: The secondary data product returns all secondaries and aliases associated with a SmartyKey. The SmartyKey can be that of the root address, any of the aliases, or any of the secondaries. Each will return the same related data. The count subset only returns the number of secondaries associated with the SmartyKey. Detailed data is not returned.
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/smartykey'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      responses:
        '200':
          $ref: '#/components/responses/SecondaryCountResponseSmartyKey'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /lookup/search/secondary/count:
    get:
      operationId: get-lookup-secondary-count
      tags:
      - us-enrichment
      summary: US Secondary Data Lookup by Search Fields
      description: The secondary data product returns all secondaries and aliases associated with a SmartyKey. Each will return the same related data. The count subset only returns the number of secondaries associated with the SmartyKey. Detailed data is not returned.
      security:
      - auth-id: []
        auth-token: []
      - embedded-key: []
      parameters:
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/etag'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/exclude'
      - $ref: '#/components/parameters/features'
      - $ref: '#/components/parameters/freeform'
      - $ref: '#/components/parameters/street'
      - $ref: '#/components/parameters/city'
      - $ref: '#/components/parameters/state'
      - $ref: '#/components/parameters/zipcode'
      responses:
        '200':
          $ref: '#/components/responses/SecondaryCountResponseSearch'
        '304':
          $ref: '#/components/responses/NotModified'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '413':
          $ref: '#/components/responses/RequestTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableContent'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    exclude:
      name: exclude
      in: query
      schema:
        type: string
      description: List of attributes that are not allowed to be included in the response. This list can include Group names and Attribute names separated by commas. All values must be lowercase.
    smartykey:
      name: smartykey
      in: path
      required: true
      schema:
        type: string
      description: The unique id associated with the address you are looking for.
    dataset:
      name: dataset
      in: path
      required: false
      schema:
        type: string
        enum:
        - '2010'
        - '2020'
    include:
      name: include
      in: query
      schema:
        type: string
      description: List of attributes that are allowed to be included in the response. This list can include Group names and Attribute names separated by commas. All values must be lowercase. If the record in the response does not have a value for that attribute, it will not be included in the response.
    freeform:
      name: freeform
      in: query
      schema:
        type: string
      description: A full address.
    zipcode:
      name: zipcode
      in: query
      schema:
        type: string
      description: The ZIP Code. You may also need to provide values for other component search fields.
    city:
      name: city
      in: query
      schema:
        type: string
      description: The city name or a city, state, and ZIP Code combined. You may also need to provide values for other component search fields.
    features:
      name: features
      in: query
      schema:
        type: string
      description: 'A comma-separated list of features. These may require a special plan that allows the feature to be used. EXAMPLE: Feature Value: financial; Description: Return the financial_history attribute. This is applicalbe only to property requests. Default: 128'
    street:
      name: street
      in: query
      schema:
        type: string
      description: The street line of the address, or the entire address. You may also need to provide values for other component search fields.
    state:
      name: state
      in: query
      schema:
        type: string
      description: The state name or abbreviation. You may also need to provide values for other component search fields.
    content-type:
      name: Content-type
      in: header
      schema:
        type: string
        example: application/json
      description: The purpose of the Content-Type field is to describe the data contained in the body fully enough that the receiving user agent can pick an appropriate agent or mechanism to present the data to the user, or otherwise deal with the data in an appropriate manner.
    etag:
      name: ETag
      in: header
      schema:
        type: string
        example: AUHQQBIPBQDAYAA
      description: 'The ETag header provides the ability to check if a record has been updated since the last query. Every query to the API will return an ETag header which represents a hash of the record in the response. This value may be stored and used in subsequent queries for that same record. If the record data has NOT been updated since the last query, it will return a 304 (Not Modified) and the client will not be charged for the query. (The 304 response does not contain a body.) If the record data HAS been updated, the latest version of the record will be returned along with a new ETag value. Important: Only the latest ETag value is valid for each record. This feature is NOT designed to retrieve past record versions. Also note that the ETag value will change if ANY data in the record has been updated, regardless of which attributes are requested using the include and exclude parameters.'
  responses:
    UnprocessableContent:
      description: 'Unprocessable content: Some parameter values are not correct. Detailed messages will describe the problem.

        '
    TooManyRequests:
      description: 'Too Many Requests: We restrict the number of requests coming from a given source over too short of a time.

        '
    CensusBlockAndTractResponseSmartyKey:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/CensusBlockAndTractResponseSmartyKey'
    SecondaryResponseSmartyKey:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/SecondaryResponseSmartyKey'
    SecondaryCountResponseSmartyKey:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/SecondaryCountResponseSmartyKey'
    PaymentRequired:
      description: 'Payment Required: There is no active subscription for the account associated with the credentials submitted with the request.

        '
    Unauthorized:
      description: 'Unauthorized: The credentials were provided incorrectly or did not match any existing, active credentials.

        '
    SecondaryCountResponseSearch:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/SecondaryCountResponseSearch'
    BadRequest:
      description: 'Bad Request (Malformed Payload): A GET request lacked a street field, or the request body of a POST request contained malformed JSON. (example: submitting an integer value in the ZIP Code field when a string is expected)

        '
    SecondaryResponseSearch:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/SecondaryResponseSearch'
    PropertyResponseSearch:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/PropertyResponseSearch'
    PropertyResponseSmartyKey:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/PropertyResponseSmartyKey'
    CensusBlockAndTractResponseSearch:
      description: Ok Response
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/CensusBlockAndTractResponseSearch'
    RequestTooLarge:
      description: 'Request entity too large: The request body was larger than 64 Kilobytes.

        '
    NotModified:
      description: 'The requested ETag header represents the latest data available.

        '
  schemas:
    Place:
      type: object
      description: The Bureau of the Census defines a place as a concentration of population. It consists of a geographical boundary.
      properties:
        accuracy:
          type: string
          description: Represents the accuracy of the geocode associated with the SmartyKey. Less than Zip9 accuracy will be inferred. Otherwise, it will be exact.
        code:
          type: string
          description: A 7-digit code that identifies the place. The first 2 digits identify the state. The last 5 identify the place within the state.
        name:
          type: string
          description: The name of the place boundary.
        type:
          type: string
          description: Indicates if the Census Place is incorporated or unincorporated.
    CensusBlockAndTractResponseSmartyKey:
      properties:
        smarty_key:
          type: string
        data_set_name:
          type: string
        data_set_version:
          type: string
        attributes:
          type: object
          properties:
            census_block:
              $ref: '#/components/schemas/CensusBlock'
            census_county_division:
              $ref: '#/components/schemas/CensusCountyDivision'
            census_tract:
              $ref: '#/components/schemas/CensusTract'
            core_based_stat_area:
              $ref: '#/components/schemas/CoreBasedStatArea'
            place:
              $ref: '#/components/schemas/Place'
    CoreBasedStatArea:
      type: object
      description: Refers collectively to metropolitan statistical areas and micropolitan statistical areas. CBSAs consist of the county or counties (or equivalent entities) associated with at least one core (urban area) with a population of at least 10,000, plus adjacent counties having a high degree of social and economic integration with the core as measured through commuting ties.
      properties:
        code:
          type: string
          description: A 5-digit unique id of the CBSA (e.g. 39340)
        name:
          type: string
          description: The name of the CBSA (e.g. Provo-Orem, UT)
    GroupStructuralAttributes:
      type: object
      description: Structural attributes in the Principal Dataset records.
      properties:
        1st_floor_sqft:
          type: string
        2nd_floor_sqft:
          type: string
        acres:
          type: string
        air_conditioner:
          type: string
        arbor_pergola:
          type: string
        attic_area:
          type: string
        attic_flag:
          type: string
        balcony:
          type: string
        balcony_area:
          type: string
        basement_sqft:
          type: string
        basement_sqft_finished:
          type: string
        basement_sqft_unfinished:
          type: string
        bath_house:
          type: string
        bath_house_sqft:
          type: string
        bathrooms_partial:
          type: string
        bathrooms_total:
          type: string
        bedrooms:
          type: string
        boat_access:
          type: string
        boat_house:
          type: string
        boat_house_sqft:
          type: string
        boat_lift:
          type: string
        bonus_room:
          type: string
        breakfast_nook:
          type: string
        breezeway:
          type: string
        building_definition_code:
          type: string
        building_sqft:
          type: string
        cabin:
          type: string
        cabin_sqft:
          type: string
        canopy:
          type: string
        canopy_sqft:
          type: string
        carport:
          type: string
        carport_sqft:
          type: string
        cellar:
          type: string
        central_vacuum:
          type: string
        community_rec:
          type: string
        construction_type:
          type: string
        courtyard:
          type: string
        courtyard_area:
          type: string
        deck:
          type: string
        deck_area:
          type: string
        depth_linear_footage:
          type: string
        driveway_sqft:
          type: string
        driveway_type:
          type: string
        effective_year_built:
          type: string
        elevator:
          type: string
        equestrian_arena:
          type: string
        escalator:
          type: string
        exercise_room:
          type: string
        exterior_walls:
          type: string
        family_room:
          type: string
        fence:
          type: string
        fence_area:
          type: string
        fire_resistance_code:
          type: string
        fire_sprinklers_flag:
          type: string
        fireplace:
          type: string
        fireplace_number:
          type: string
        flooring:
          type: string
        foundation:
          type: string
        game_room:
          type: string
        garage:
          type: string
        garage_sqft:
          type: string
        gazebo:
          type: string
        gazebo_sqft:
          type: string
        golf_course:
          type: string
        grainery:
          type: string
        grainery_sqft:
          type: string
        great_room:
          type: string
        greenhouse:
          type: string
        greenhouse_sqft:
          type: string
        gross_sqft:
          type: string
        guesthouse:
          type: string
        guesthouse_sqft:
          type: string
        handicap_accessibility:
          type: string
        heat:
          type: string
        heat_fuel_type:
          type: string
        hobby_room:
          type: string
        intercom_system:
          type: string
        interior_structure:
          type: string
        kennel:
          type: string
        kennel_sqft:
          type: string
        laundry:
          type: string
        lean_to:
          type: string
        lean_to_sqft:
          type: string
        loading_platform:
          type: string
        loading_platform_sqft:
          type: string
        lot_sqft:
          type: string
        media_room:
          type: string
        milkhouse:
          type: string
        milkhouse_sqft:
          type: string
        mobile_home_hookup:
          type: string
        mud_room:
          type: string
        number_of_buildings:
          type: string
        office:
          type: string
        office_sqft:
          type: string
        overhead_door:
          type: string
        parcel_shell_record:
          type: string
        parking_spaces:
          type: string
        patio_area:
          type: string
        plumbing_fixtures_count:
          type: string
        pole_struct:
          type: string
        pole_struct_sqft:
          type: string
        pond:
          type: string
        pool:
          type: string
        pool_area:
          type: string
        poolhouse:
          type: string
        poolhouse_sqft:


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/smarty/refs/heads/main/openapi/smarty-us-enrichment-api-openapi.yml