Quantcast
Channel: The U.S. Small Business Administration | SBA.gov - Web Service API
Viewing all articles
Browse latest Browse all 7

Dynamic Small Business Search (DSBS) API

$
0
0

Table of contents:

  1. Summary
  2. Request Methods
    • Federal Programs
  3. Response Format
    • XML Format
    • JSON Format

1. Summary

Search tool that accesses information data from the external  System for Award Management (SAM) for firms that the SBA considers small along with additional data provided by the firms and any SBA certifications.  Used by small businesses to increase their visibility to government and business procurement offices searching for small businesses to meet small business contracting goals.

The API is RESTful and output formats are available in XML and JSON.
There is a WSDL for the XML output available.

2. Request Methods

Federal Programs

URL template:

https://eweb1.sba.gov/dsbs/ws/dsbs.format

Example URL:

https://eweb1.sba.gov/dsbs/ws/dsbs.wsdl

Parameters:

FORMAT

Either xmlor json, case sensitive.

3. Response Format

XML Format

The XML response is well-documented in the XML WSDL for this document type.
The document root element's tag-name is <Search>.Each record within the document is contained within a <Search>element, containing sub-elements as detailed in the JSON Format documentation below. Each of these sub-elements contains its relevant data as Parsed Character Data.

JSON Format

The JSON response consists of an array of anonymous objects, each of which represents a grant or loan.
Each of these objects has the following properties:

Location of Profile

Field Name

Meaning

Description

DSBS_State

State

  • Delimited entries
  • List of all US states, territories, APO, and FPO entries

DSBS_Cdist

Congressional District

  • Business congressional district
  • Only valid when combined with state

DSBS_Cnty

County

  • County
  • Only valid when combined with state

DSBS_Phone

Phone

  • Area Code or Phone Number Initial Fragment

DSBS_Msa

Metropolitan Statistical Area

MSA codes for specific cities

DSBS_SbaOffice

SBA Office

SBA District or Branch Office where small business is located

DSBS_Zip

Zip Code

Zip Code for business

Government Certifications

Field Name

Meaning

Description

DSBS_E8a

E8(a) Certification

Possible values:

  • Y = Required (Active Certifications only)
  • E = Required (Active Certifications and Previously Certified)
  • P = Required (Previously Certified only)
  • N = Not Required

DSBS_Sdb

Small Disadvantaged Business

Possible values:

  • Y = Required (Active Certifications only)
  • E = Required (Active Certifications and Previously Certified)
  • P = Required (Previously Certified only)
  • N = Not Required

DSBS_Dbe

Disadvantaged Business Enterprise

  • Delimited entries
  • List of all US states, territories, APO, and FPO entries

DSBS_HubCert

HUBZone Certification

Possible values:

  • Y = Required (Active Certifications only)
  • E = Required (Active Certifications and Previously Certified)
  • P = Required (Previously Certified only)
  • N = Not Required

Ownership and Self-Certifications

Field Name

Meaning

Description

DSBS_CBT

Minority ownership categories except HUBZone

Possible values:

  • Min = Any Minority
  • Nat = Any Native American
  • NatTri = Tribally
  • NatAla = Alaskan Native Corp (ANC)
  • NatHaw = Native Hawaiian Org (NHO)
  • NatOth = Other Native American
  • MinOth = Other Minority
  • CDC = Community Development Corporation (CDC)
  • SCS = Self-Certified Small Disadvantaged Business
  • SDV = Service Disabled Veteran
  • Vet = Owned (including Service Disabled Veteran)
  • Wom = Any Women-Owned Small Business
  • Wosb = Women-Owned Small Business under the Women-Owned Small Business Program
  • EdWosb = Economically Disadvantaged Women-Owned Small Business under the Women-Owned Small Business Program
  • WosbJV = Women-Owned Small Business Joint Venture
  • EdWosbJV = Economically Disadvantaged Women-Owned Small Business Joint Venture

Specific Nature of Business

Field Name

Meaning

Description

DSBS_AnyAllNaics

Any or All NAICS Codes

  • Possible values:
    • Any = if company has any of the delimited NAICS Codes
    • All = company must have all delimited NAICS Codes

DSBS_AnyAllGreen

Any or All “Buy Green” NAICS Codes

  • Possible values:
    • Any = if company has any of the delimited Green NAICS Codes
    • All = company must have all delimited Green NAICS Codes

DSBS_AnyAllKeywords

Any or All Keywords

  • Possible values:
    • Any = if company has any of the delimited Key Words
    • All = company must have all delimited Key Words

DSBS_Naicses

North American Industrial Classification System Codes

  • Delimited entries
  • NAICS codes

DSBS_Greens

Buy Green NACIS Code

  • Delimited entries
  • Green NAICS codes

DSBS_Keywords

Key Words

Delimited entries

General Nature of Business

Field Name

Meaning

Description

DSBS_Area

General Nature of Business

Possible Values as a comma delimited string:

  • MFG = Manufacturing
  • CON = Construction
  • RAD = Research and Development
  • SVC = Servicing

Minimum Acceptable Bonding Levels

Field Name

Meaning

Description

DSBS_Cbona

Construction Bonding Level Aggregate

Minimum Construction Bonding Amount Aggregate

  • Up to 11 characters with dollars, cents, commas, and decimal point allowed but not required

DSBS_Cbonc

Construction Bonding Level Per Contract

  • Minimum Construction Bonding Amount Per Contract
  • Up to 11 characters with dollars, cents, commas, and decimal point allowed but not required

DSBS_Sbona

Service Bonding Level (aggregate)

  • Minimum Service Bonding Amount (aggregate)
  • Up to 11 characters with dollars, cents, commas, and decimal point allowed but not required

DSBS_Sbonc

Service Bonding Level (per contract)

  • Minimum Service Bonding Amount (per contract)
  • Up to 11 characters with dollars, cents, commas, and decimal point allowed but not required

Quality Assurance Standards

Field Name

Meaning

Description

DSBS_Qas

Quality Assurance Standards

  • Recognized quality standards
  • Possible values:
    • B = ANSI/ASQC Z1.4
    • A = ISO-9000 Series
    • I = ISO 10012-1
    • F = MIL-Q-9858
    • E = MIL-STD-45662A

Size

Field Name

Meaning

Description

DSBS_AtLeastNoMore

At Least or No More Than

  • Possible values
    • A = At Least
    • N = No More
  • Only one value can be passed in

DSBS_Anemp

Average Number of Employees

1 to 4 digits

DSBS_Agr

Annual Gross Revenue

Dollar amount up to 11 digits with dollars, commas, decimal point, and cents, but not required

Capabilities

Field Name

Meaning

Description

DSBS_Gcc

Accepts government credit card?

Possible values:

  • Y = Required
  • N = Not Required

DSBS_Gsa

GSA Advantage Contract

Possible values:

  • Y = Required
  • N = Not Required

DSBS_ExportCd

Exporter

Possible values:

  • Y = Yes
  • W = Wants to be
  • E = Either
  • N = Not Required

DSBS_InTMO

Has Export Profile in TM Online

Possible values:

  • Checked =Yes
  • Not Checked =No

Searching for Specific Profile

Field Name

Meaning

Description

DSBS_CageCd

Cage Code

 

DSBS_Dunses

DUNS Numbers

 

DSBS_E8acase

E8(a) Case Number

 

DSBS_CompanyName

Company Name

 

DSBS_CompanyNameSearch

Company Name Search delimeter

Possible values:

  • S = sounds like
  • F = first letters matching
  • C = contains matching

Profile Status

Field Name

Meaning

Description

DSBS_UpdBefAft

Updated Before or After

Possible values:

  • B = On or before
  • A = On or after

DSBS_Updated

Date Updated

MM/DD/YYYY

DSBS_Status

Status

Possible values:

  • A = Active
  • E = Expired Registration is SAM
  • R = Not Fully Registered in SAM
  • S =  No Longer Small

Search Results Display Options

Field Name

Meaning

Description

DSP_NumberOfRows

Number of rows to be displayed per screen

Possible values:

  • 5
  • 10
  • 15
  • 20
  • 25
  • 50
  • 75
  • 100
  • 200
  • 500
  • 1000
  • 1500
  • Show All

DSBS_FirmListColumnNamesDisplay

Columns to be displayed

Columns will be displayed in order entered

DSBS_FontSize

Font size

Possible values:

  • Tiny = 6 point
  • Small = 8 point
  • Normal = 10 point
  • Large = 12 point
  • Very Large = 14 point

DSBS_Report

Report format

Possible values:

  • T = table
  • S = HTML
  • M = Mail Merge
  • V = Vertical

DSBS_Suffix

HTML Saved file extension

Possible values:

  • .txt = text
  • .xls = spreadsheet

DSBS_Delimiter

Mail merge format delimiter

Possible values:

  • C = comma
  • B = comma and blank
  • T = tab

Target Export Market Countries

Field Name

Meaning

Description

DSBS_ExpCountry

Target Export Market Countries

  • List of all countries US businesses can export to
  • Does not include countries on the US Embargo List

Export Desired Business Relationship

Field Name

Meaning

Description

DSBS_ExpMrkt

Specific desired export trading relationship

Possible values:

  • Direct export sales
  • Distributor/Importer
  • Representative/Agent/Broker
  • Overseas retailers
  • Licensing
  • Franchising
  • Contract manufacturing
  • Joint venture/co-venture
  • Wholly owned subsidiaries/brances
  • Alliances
  • Investment
  • All types of business relationships

Export Business Activity

Field Name

Meaning

Description

DSBS_ ExpMainAct

Current US small business activity

Possible values:

  • Manufacturer
  • Distributor/Agent
  • Broker (Intermediary)
  • Retailer
  • Services
  • Consultant
  • Financing

 


Viewing all articles
Browse latest Browse all 7

Trending Articles