Florida Realtors logo Florida Realtors API Documentation
Endpoint: /profile
Florida Realtors Member/Office Profile pages.
Search
Request: POST
POST https://api-dev.floridarealtors.org/profile/search
Parameter Type
searchType (required, 'M' for member search, 'F' for office search) string
firstName (optional, ignored by office search) string
lastName (optional, ignored by office search) string
city (optional) string
zip (optional) string
companyName (optional) string
specialty (optional, comma separated list of values) string
language (optional) string
designation (optional, ignored by office search) string
offset (optional) string
limit (optional, default = 60, max = 60) string
Response: SUCCESS
{
    "data_count": {data_count}},
    "data": [
        {
            "ID": {ID},
            "FIRST_NAME": {FIRST_NAME}, (for office search, broker name returned)
            "MIDDLE_INIT": {MIDDLE_INIT}},
            "LAST_NAME": {LAST_NAME},
            "OFFICE_NAME": {OFFICE_NAME}},
            "OFFICE_PHONE": {OFFICE_PHONE},
            "ADDRESS_1": {ADDRESS_1},
            "ADDRESS_2": {ADDRESS_2},
            "CITY": {CITY},
            "STATE": {STATE},
            "ZIPCODE": {ZIPCODE},
            "ZIP4": {ZIP4}
        },
        ...
    ]
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Details
Request: POST
POST https://api-dev.floridarealtors.org/profile/details
Parameter Type
id (required, prepended with 'M' or 'F') string
Response: SUCCESS
{
    "REALTOR_ID": {REALTOR_ID}, (Individual information is for DR on Firm Details Search)
    "FIRST_NAME": {FIRST_NAME},
    "MIDDLE_INIT": {MIDDLE_INIT},
    "LAST_NAME": {LAST_NAME},
    "SURNAME": {SURNAME},
    "LICENSE_NO": {LICENSE_NO},
    "NRDS_ID": {NRDS_ID},
    "EMAIL": {EMAIL},
    "FIRM_ID": {FIRM_ID},
    "OFFICE_NAME": {OFFICE_NAME},
    "ADDRESS_1": {ADDRESS_1},
    "ADDRESS_2": {ADDRESS_2},
    "CITY": {CITY},
    "STATE": {STATE},
    "ZIPCODE": {ZIPCODE},
    "ZIP4": {ZIP4},
    "OFFICE_PHONE": {OFFICE_PHONE},
    "FAX_NO": {FAX_NO},
    "CELLULAR_NO": {CELLULAR_NO},
    "PHONE_NO": {PHONE_NO},
    "AFFILIATIONS": {AFFILIATIONS},
    "LANGUAGES": {LANGUAGES},
    "MARKET_AREAS": {MARKET_AREAS},
    "DESIGNATIONS": {DESIGNATIONS},
    "ABOUT": {ABOUT},
    "EDUCATION": {EDUCATION},
    "SERVICE_AREAS": {SERVICE_AREAS},
    "EXPERIENCE": {EXPERIENCE},
    "WEBSITE": {WEBSITE},
    "SOCIAL": {
        "TYPE": {URL},
        ...
    },
    "PHOTO_URL": {PHOTO_URL},
    "LOGO_URL": {LOGO_URL}
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Update
Request: POST
POST https://api-dev.floridarealtors.org/profile/update
Parameter Type
id (required, w/ prefix) string
languages (required, comma separated language codes) string
specialties (required, comma separated specialty codes) string
market_areas (required, comma separated city codes) string
designations (required, comma separated designation codes) string
about (required) string
education (required) string
service_areas (required) string
experience (required) string
website (required) string
Response: SUCCESS
{
    same as details
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Update Socials
Request: POST
POST https://api-dev.floridarealtors.org/profile/updatesocials
Parameter Type
realtor_id (required, no prefix) string
SOCIAL_MEDIA_TYPE (optional) string, multiple, param name is social media type, value is URL. Valid types FACEBOOK/INSTAGRAM/LINKEDIN/TIKTOK/TWITTER/YOUTUBE. Send none to clear social media values for user.
EXAMPLE
{
  "realtor_id":"123456",
  "FACEBOOK":"https://facebook.com",
  "TIKTOK":"https://tiktok.com"
}

// CLEAR SOCIALS FOR USER

{
  "realtor_id":"123456"
}
Response: SUCCESS
{
    "SOCIAL_TYPE": "URL",
    ...
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Get Cities
Request: POST
POST https://api-dev.floridarealtors.org/profile/getcities
Parameter Type
Response: SUCCESS
{
    "CITY_ID": {CITY_NAME},
    ...
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Get Zip Codes
Request: POST
POST https://api-dev.floridarealtors.org/profile/getzipcodes
Parameter Type
Response: SUCCESS
{
    "ZIP_CODE": {ZIP_CODE},
    ...
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Get Specialties
Request: POST
POST https://api-dev.floridarealtors.org/profile/getspecialties
Parameter Type
Response: SUCCESS
{
    "SPECIALTY_CODE": {SPECIALTY_DESCRIPTION},
    ...
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Get Languages
Request: POST
POST https://api-dev.floridarealtors.org/profile/getlanguages
Parameter Type
Response: SUCCESS
{
    "LANGUAGE_CODE": {LANGUAGE_NAME},
    ...
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details
Get Designations
Request: POST
POST https://api-dev.floridarealtors.org/profile/getdesignations
Parameter Type
Response: SUCCESS
{
    "DESIGNATION_CODE": {DESIGNATION_DESCRIPTION},
    ...
}
Response: ERROR
Error Code Error Type
401 Unauthorized Access Denied
400 Bad Request Missing Required Parameter
See Exception Documentation for more details