REST API

Get Buyer Attribute

Retrieve a single structured attribute about a buyer (institution) by its key, as defined in the BuyerField enum. Buyers include cities, counties, higher-education institutions, school districts, police and fire departments, federal agencies, and other public-sector entities. See the buyerAttribute parameter for the full list of available keys and what each one returns.

If you need more than one attribute for the same buyer, use the bulk endpoint getBuyerAttributesBulk instead. It returns multiple attributes in a single request, saving you from making separate calls for each one.

GET

api

external

buyer

{buyerId}

attribute

{buyerAttribute}

Get Buyer Attribute

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "buyerData": "<unknown>"
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication

Path Parameters

buyerId

string

required

buyerAttribute

enum<string>

required

The BuyerField key to retrieve.

Available options:

Id,

Name,

CommonName,

ParentName,

ParentBuyerId,

Type,

Classifications,

Url,

LinkedinSlug,

Zip,

CountryCode,

StateCode,

StateName,

City,

County,

Address,

Street1,

Street2,

MainPhoneNumber,

EmailDomains,

Population,

PopulationTrend,

PopulationOneYearChangePercentage,

PopulationFiveYearChangePercentage,

PopulationDensityPerSquareMile,

CountyHudAssistedHousingUnitCount,

HudAreaMedianFamilyIncome,

CountyMedicareAdvantageEnrollmentCount,

CountyMedicareAdvantagePenetrationPercentage,

CountyMedicareMedicaidEnrolleeCount,

CountyOriginalMedicareEnrollmentCount,

FemaDisasterDeclarationCount,

FemaFireDisasterDeclarationCount,

FemaFloodDisasterDeclarationCount,

FemaSevereStormDisasterDeclarationCount,

FemaWinterStormDisasterDeclarationCount,

BudgetAmount,

BudgetSbita,

BudgetUrl,

BudgetLatestYear,

BudgetConfidence,

SchoolDistrictType,

HigherEdFullTimeEnrollment,

HigherEdInstitutionType,

DepartmentName,

DepartmentCode,

AgencyName,

OfficeCodeArray,

AgencyCode,

AiAdoptionScore,

AiAdoptionSummary,

StartupFriendlinessScore,

StartupFriendlinessSummary,

ProcurementHellScore,

AngelProcurementSummary,

IpedsIdNumeric,

TotalEnrollment,

NcesId,

NcesStateDistrictId,

CensusIdPid6,

CensusIdGidId,

SgcId,

HigherEdGraduationRate,

HigherEdRetentionRate,

HigherEdAcceptanceRate,

HigherEdYieldRate,

HigherEdGraduationEnrollment,

HigherEdUndergradEnrollment,

HigherEdOnlineOnlyEnrollment,

HigherEdControlOfInstitution,

HigherEdForProfitStatus,

HigherEdLevelOfInstitution,

HigherEdRecruitmentAdmissionsCrmArray,

HigherEdEndowment,

HigherEdTotalExpenses,

HigherEdMascot,

HigherEdNumberOfOnCampusResidents,

HigherEdNumberOfFullTimeEmployees,

HigherEdSisModernizationStatus,

HigherEdPrimaryRegionalAccreditor,

HigherEdAccreditationSummary,

HigherEdAccreditationStatus,

DapipId,

HigherEdNextAccreditationReviewDate,

HigherEdSystem,

CommunityCollegeSystem,

HigherEdContinuingProfessionalEducationOffered,

Sis,

LmsArray,

SchoolDistrictLocale,

SchoolDistrictFullTimeEquivalentTeachers,

LowestGradeOffered,

HighestGradeOffered,

SchoolYearStartDate,

SchoolYearEndDate,

SchoolDistrictNumberOfSchools,

SchoolDistrictNewlyOpenedSchoolCount,

SchoolDistrictClosedSchoolCount,

SchoolDistrictElementarySchools,

SchoolDistrictMiddleSchools,

SchoolDistrictHighSchools,

SchoolDistrictTotalStaff,

SchoolDistrictMedianHouseholdIncome,

SchoolDistrictSector,

RegionalEducationServiceAgencyName,

RegionalEducationServiceAgencyBuyerId,

SchoolManagementOrganizationName,

SchoolManagementOrganizationBuyerId,

EnglishLearners,

BlackPercentage,

LatinoPercentage,

WhitePercentage,

StudentTeacherRatio,

SchoolSector,

SchoolLevel,

AlternativeSchool,

SchoolCurriculumProgramArray,

ReligiousAffiliation,

StudentGenderComposition,

SchoolVirtualStatus,

Subentity,

FiscalYearStartDate,

FreeOrReducedLunchEligiblePercentage,

FdId,

FireDepartmentType,

FireDepartmentOrganizationType,

FireDepartmentPrimaryAgency,

FireDepartmentNumberOfStations,

FireDepartmentActiveFirefightersCareer,

FireDepartmentActiveFirefightersVolunteer,

FireDepartmentActiveFirefightersPaidPerCall,

FireDepartmentNonFirefightingCivilian,

FireDepartmentNonFirefightingVolunteer,

PoliceOri,

PoliceOfficerCt,

PoliceDepartmentType,

HasCampusPolice,

Psap,

StateAgencySector,

EmployeeFte,

WaterSystemPopulationServed,

SpecialDistrictResidentPopulationEstimate,

MotorCarrierPowerUnits,

PropensityToSpendScore,

PropensityToSpendSummary,

BudgetChangeAnalysisSourceUrls,

PropensityToSpend,

YoyChangeInEnrollment,

EnrollmentTrend,

EnrollmentTrendBasedOnFte,

AtsiDesignation,

SpecialEducationEnrollment,

SpecialEducationEnrollmentPercentage,

TsiDesignation,

CsiDesignation,

SchoolDistrictTotalRevenue,

SchoolDistrictFederalRevenue,

SchoolDistrictStateRevenue,

SchoolDistrictLocalRevenue,

PerPupilExpenditure,

MathProficiencyPercentage,

ElaProficiencyPercentage,

MathProficiencyStatePercentile,

ElaProficiencyStatePercentile,

TitleIFunding,

TitleIiFunding,

TitleIiiFunding,

TitleIvFunding,

TitleVFunding,

FederalGrantComplianceRisk,

FederalGrantComplianceCapSummary,

ErateFunding,

IhbgFinalAllocationAmount,

TribalTransportationProgramShare,

BuyerLocationLatitude,

BuyerLocationLongitude,

StarbridgeUrl

Response

The requested attribute value wrapped in BuyerAttributeResponse.

buyerData

any

required

Any JSON value - can be a string, number, boolean, object, array, or null

⌘I

Get Buyer Attribute

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attribute/{buyerAttribute}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "buyerData": "<unknown>"
}