Contracts API

 

Global Parameters

Name Required (Y/N) Format/Value Description Example
type_of_data Y String - Maximum 15 characters. Allows user to select different types of data. Value must be one of the following:Contracts, Budget, Revenue, Payroll, Spending, Spending_OGE, Contracts_OGE, Spending_NYCHA, Contracts_NYCHA and Payroll_NYCHA Contracts
max_records N String - Maximum 4 characters Allows you to set the maximum number of records retrieved to fewer than 1000 500
record_from N String - Maximum 15 characters Allows you to set the starting position of the records to be retrieved 12500

Back to the top

type_of_data: Contract

Contract Parameters – All the parameters are optional, meaning that you can send only 1 or all of them. If you choose to not send any, you will receive random transactions in return as these parameters are the filter. Column fields marked with an asterisk (*) are applicable to Citywide and Other Government Entity ( NYCEDC ).

Name Required (Y/N) Type of Criteria (Value/Range) Format/Value Applicable Filters Category* Contract Status* Description Reference Codes Example
fiscal_year N value String - YYYY - Maximum 4 characters Citywide Agencies and Other Government Entities(NYCEDC, NYCHA) Expense
Revenue 		Active
Registered 		Fiscal Year. Must be exactly 4 characters. By default, all years are pre-selected. The response column would be ‘year’.   2005
status Y value Allows you to select from three possible contract statuses. Values must be one of the following: active, pending or registered. Citywide Agencies and Other Government Entities (NYCEDC) Expense
Revenue 		Active
Registered
Pending 		Allows you to select from three possible contract statuses. Values must be one of the following: active, pending or registered. Allows user to search for both Prime and Sub Vendor data(only for active and registered expense contracts)   active
category Y value Allows you to select possible contract category types. Values must be one of the following: all, expense, revenue. Citywide Agencies and Other Government Entities (NYCEDC) All
Expense
Revenue 		Active
Registered
Pending 		Allows you to select possible contract category types. Values must be one of the following: all, expense, revenue. Allows user to search for both Prime and Sub Vendor data(only for active and registered expense contracts)   expense
prime_vendor N value String/Maximum 20 Characters Other Government Entities(NYCEDC) Expense
Revenue 		Active
Registered
Pending 		Vendor name. The user shall be able to search using vendor name. The search will return all results that match the first three letters of the vendor name.   Apple inc
vendor_code N value String - Maximum 20 characters Citywide Agencies and Other Government Entities (NYCHA) Expense
Revenue 		Active
Registered
Pending 		Identification code associated with vendor. Allows user to search for both Prime and Sub Vendor data(only for active and registered expense contracts) Citywide: vendor codes list NYCHA: vendor codes list 0000631395
contract_type N value String - Maximum 2 characters Citywide Agencies and Other Government Entities (NYCEDC,NYCHA) Expense
Revenue 		Active
Registered
Pending 		Indicates the agreement type. Citywide: contract types list NYCHA: contract types list 50
agency_code N value String - Maximum 3 characters Citywide Agencies Expense
Revenue 		Active
Registered
Pending 		Identification code associated with agency. Citywide: agency codes list 127
contract_id N value String - Maximum 32 characters Citywide Agencies and Other Government Entities (NYCEDC,NYCHA) Expense
Revenue 		Active
Registered
Pending 		Contract number.   CTA1001544
award_method N value String - Maximum 3 characters Citywide Agencies and Other Government Entities (NYCEDC, NYCHA) Expense
Revenue 		Active
Registered
Pending 		Indicates how vendors are to be awarded based on the information entered in the table. Citywide: award method codes list NYCHA: award method codes list 115
current_amount N range String - Maximum 18 characters Citywide Agencies and Other Government Entities (NYCEDC, NYCHA) Expense
Revenue 		Active
Registered
Pending 		Current amount associated with a contract. Allows user to search for both Prime and Sub Vendor data(only for active and registered expense contracts)   20000.00
start_date N range String - YYYY-MM-DD Citywide Agencies and Other Government Entities (NYCEDC, NYCHA) Expense
Revenue 		Active
Registered
Pending 		Start date associated with a contract. For NYCHA, this field shall not be applicable when user selects Purchase Order type as 'ALL' or 'PO'.   1999-01-09
end_date N range String - YYYY-MM-DD Citywide Agencies and Other Government Entities (NYCEDC, NYCHA) Expense
Revenue 		Active
Registered
Pending 		End date associated with a contract. For NYCHA, this field shall not be applicable when user selects Purchase Order type as 'ALL' or 'PO'.   2011-01-09
registration_date N range String - YYYY-MM-DD Citywide Agencies Expense
Revenue 		Active
Registered 		Registration date associated with a contract   2000-02-02
received_date N range String - YYYY-MM-DD Citywide Agencies Expense
Revenue 		Pending Recieved date associated with a contract   2009-03-03
budget_name N value String- Maximum 75 characters Other Government Entities (NYCEDC) Expense Active
Registered 		Budget name. The user shall be able to search using budget name. The search will return all results that match the first three letters of the budget name.   28TH AVENUE AND LINDEN PLACE AREA
commodity_line N value String- Maximum 3 characters Other Government Entities (NYCEDC) Expense Active
Registered 		Commodity line associated to EDC contracts.   1
entity_contract _number N value String- Maximum 15 characters Other Government Entities (NYCEDC) Expense Active
Registered 		Identification code associated with OGE contract. The user would need to enter the contract number manually.   48440001
other_government _entities_code N value String- Maximum 3 characters Other Government Entities (NYCEDC) Expense Active
Registered 		Identifies which government entities the user would want to search. Code for EDC is z81.   z81
mwbe_category N value String- Maximum 20 characters Citywide Agencies Expense
Revenue 		Active
Registered
Pending 		User shall be able to extract data for specific mwbe categories, by specifying the mwbe category code in the request XML. For all m/wbe categories results, user need not give any m/wbe category codes in the request. By default, it shall display results for all categories. For Total M/WBE, include all the m/wbe category codes in the request XML, which is 1~2~3~4~5~10~6~9~99. Allows user to search for both Prime and Sub Vendor data(only for active and registered expense contracts) Citywide: mwbe categories list 3
industry N value String- Maximum 2 characters Citywide Agencies and Other Government Entities ( NYCHA) Expense
Revenue 		Active
Registered
Pending 		User shall be able to extract data for specific industry types, by specifying the industry type codes in the request XML. By default, it shall display results for all industries.Allows user to search for both Prime and Sub Vendor data(only for active and registered expense contracts) Citywide: industry codes list NYCHA: industry codes list 1
contract_includes _sub_vendors N value String- Maximum 2 characters Citywide Agencies Expense Active
Registered 		Identifies the subcontract status for prime contract. Citywide: status codes 2
sub_contract_status N value String- Maximum 2 characters Citywide Agencies Expense Active
Registered 		Identifies the subcontract status in for prime contract. Allows user to search for both Prime and Sub Vendor data(only for active and registered expense contracts) Ciywide:
status codes 		2
purchase_order_type N value String- Maximum 2 characters Other Government Entities(NYCHA) N/A N/A Identifies the Purchase order type. NYCHA: Purchase Order codes BA
approved_date N value String- Maximum 2 characters Other Government Entities(NYCHA) N/A N/A Identifies the approved date associated with a Purchase Order.This field shall not be applicable when user selects Purchase Order type as 'ALL' or 'BA' or 'PA'.   2020-02-02
responsibility_center N value String- Maximum 2 characters Other Government Entities(NYCHA) N/A N/A Identification code associated with Responsibility Center. NYCHA: Responsibility Center codes K126100
conditional_category N value String- Maximum 2 characters Citywide Agencies Expense Active
Registered
Pending 		Identification id associated with conditional category. Citywide: Conditional Categories Id 1
contract_class N value String- Maximum 100 characters Citywide Agencies Expense
Revenue 		Active
Registered
Pending 		Contract class description. MIXED/SPLIT FUNDED

Back to the top

Possible response columns:

User would be able to select which columns he would like to view in his output. Below mentioned are the possible column names for the domain. The user should include the required column names in the request xml in an element called <response_columns>. Please note:

  1. For pending contracts, the data is displayed for all versions of the contract.
  2. If no year is provided in the search criteria, all years are considered and only the latest version of the contract will be displayed in the results. The response column year will not be applicable for all years. The user can categorize the year based on start and end date of the contract which will be populated in the results.
 
(Citywide)Response Column Names_Active & Registered Category-All
prime_contract_id prime_contract_industry
contract_includes_sub_vendors prime_contract_pin
prime_vendor prime_contract_apt_pin
percent_covid_spending
percent_other_spending prime_vendor_mwbe_category
sub_vendor prime_contract_purpose
sub_vendor_mwbe_category prime_contract_current_amount
sub_contract_purpose prime_contract_original_amount
sub_contract_status prime_vendor_spent_to_date
sub_contract_industry prime_contract_start_date
sub_contract_current_amount prime_contract_end_date
sub_contract_original_amount sub_contract_registration_date
sub_vendor_paid_to_date prime_contracting_agency
sub_contract_start_date prime_oca_number
prime_contract_version sub_contract_end_date
parent_contract_id document_code
prime_contract_type sub_contract_reference_id
prime_contract_award_method year
prime_contract_expense_category prime_woman_owned_business
prime_emerging_business sub_woman_owned_business
sub_emerging_business mocs_registered
contract_class
 
(Citywide)Response Column Names_Active & Registered Category-Expense
prime_contract_id prime_contract_industry
contract_includes_sub_vendors prime_contract_pin
prime_vendor prime_contract_apt_pin
percent_covid_spending
percent_other_spending prime_vendor_mwbe_category
sub_vendor prime_contract_purpose
sub_vendor_mwbe_category prime_contract_current_amount
sub_contract_purpose prime_contract_original_amount
sub_contract_status prime_vendor_spent_to_date
sub_contract_industry prime_contract_start_date
sub_contract_current_amount prime_contract_end_date
sub_contract_original_amount sub_contract_registration_date
sub_vendor_paid_to_date prime_contracting_agency
sub_contract_start_date prime_oca_number
prime_contract_version sub_contract_end_date
parent_contract_id document_code
prime_contract_type sub_contract_reference_id
prime_contract_award_method year
prime_contract_expense_category prime_woman_owned_business
prime_emerging_business sub_woman_owned_business
sub_emerging_business mocs_registered
contract_class
 
(Citywide)Response Column Names_Active & Registered Category-Revenue
contract_id purpose
oca_number version
agency apt_pin
award_method current_amount
original_amount pin
prime_vendor prime_vendor_
mwbe_category
contract_type industry
start_date end_date
registration_date document_code
year woman_owned_business
emerging_business contract_class
 
(Citywide)Response Column Names_Pending Category-Expense, Revenue and All
contract_id purpose
oca_number version
agency apt_pin
award_method current_amount
original_amount pin
prime_vendor prime_vendor_
mwbe_category
contract_type industry
start_date end_date
received_date document_code
original_modified parent_contract_id
woman_owned_business emerging_business
contract_class  
 
(Other Government Entities - NYCEDC)Response Column Names_Active & Registered Category-Expense
contract_id prime_vendor
purpose other_government_entities
version contract_type
parent_contract_id award_method
original_amount expense_category
current_amount start_date
spent_to_date end_date
document_code contract_industry
year budget_name
entity_contract_number commodity_line
 
(Other Government Entities - NYCHA)Response Column Names
other_government_entities release_current_amount
year release_original_amount
contract_id release_invoiced_amount
purchase_order_type contract_current_amount
record_type contract_original_amount
number_of_releases contract_invoiced_amount
release_number purpose
line_number vendor
item_category location
item_description contract_type
quantity_ordered award_method
shipment_number grant_name
responsibility_center expenditure_type
start_date industry
end_date funding_source
approved_date pin
line_current_amount program
line_original_amount project
line_invoiced_amount  
 

Back to the top

Predefined Entities in XML

The user has to encode the names using the predefined entities list embedded below, while searching using names (payee_name, budget_name, vendor, and purpose). The table below lists the five XML predefined entities. The "Name" column mentions the entity's name. The "Character" column shows the character. To render the character, the format &name; is used; for example, &amp; renders as &.

Name Character Description Representation Example Text Example Request/Response
quot " double quotation mark &quot; “Gilbane” &quot;Gilbane&quot;
amp & ampersand &amp; Mckissack & Mckissack Mckissack &amp; Mckissack
apos ' apostrophe (apostrophe-quote) &apos; ‘turner’ &apos; turner &apos;
lt < less-than sign &lt; <gilbane building &lt;gilbane building
gt > greater-than sign &gt; gilbane building> gilbane building&gt;

Back to the top

Sample XML Requests and Responses

The following xml file will specify API method calls and the details for each call.

The request xml would include global parameters which specify the selected domain, records from and maximum records to return in response. It also includes search parameters along with requested response column.

In the response xml, the actual search parameters that were sent will be returned in an element called <search_criteria> along with the actual result for a given search criteria will be displayed in an element called <result_records>.

The total number of resulting records for a given search criteria will be displayed within an element called <record_count>, which helps user to view the total number of records found for a given search criteria.

The response xml also includes status messages for the result. If there is an error, corresponding error code along with description will be included in an element called <messages> for user reference.

Back to the top

Sample Request: Contract Transactions Active Expense (Citywide)

<request>
  <type_of_data>Contracts</type_of_data>
  <records_from>1</records_from>
  <max_records>100</max_records>
  <search_criteria>
    <criteria>
      <name>status</name>
      <type>value</type>
      <value>active</value>
    </criteria>
    <criteria>
      <name>category</name>
      <type>value</type>
      <value>expense</value>
    </criteria>
    <criteria>
      <name>fiscal_year</name>
      <type>value</type>
      <value>2016</value>
    </criteria>
    <criteria>
      <name>agency_code</name>
      <type>value</type>
      <value>850</value>
    </criteria>
    <criteria>
      <name>vendor_code</name>
      <type>value</type>
      <value>0001466800</value>
    </criteria>
    <criteria>
      <name>contract_id</name>
      <type>value</type>
      <value>CT185020151429177</value>
    </criteria>
    <criteria>
      <name>contract_type</name>
      <type>value</type>
      <value>05</value>
    </criteria>
    <criteria>
      <name>award_method</name>
      <type>value</type>
      <value>01</value>
    </criteria>
    <criteria>
      <name>industry</name>
      <type>value</type>
      <value>1</value>
    </criteria>
    <criteria>
      <name>mwbe_category</name>
      <type>value</type>
      <value>9</value>
    </criteria>
    <criteria>
      <name>contract_includes_sub_vendors</name>
      <type>value</type>
      <value>2</value>
    </criteria>
    <criteria>
      <name>sub_contract_status</name>
      <type>value</type>
      <value>4</value>
    </criteria>
  </search_criteria>
  <response_columns>
    <column>prime_contract_id</column>
    <column>contract_includes_sub_vendors</column>
    <column>prime_vendor</column>
    <column>prime_vendor_mwbe_category</column>
    <column>prime_contract_purpose</column>
    <column>prime_contract_original_amount</column>
    <column>prime_contract_current_amount</column>
    <column>prime_vendor_spent_to_date</column>
    <column>prime_contract_start_date</column>
    <column>prime_contract_end_date</column>
    <column>prime_contract_registration_date</column>
    <column>prime_contracting_agency</column>
    <column>prime_oca_number</column>
    <column>prime_contract_version</column>
    <column>parent_contract_id</column>
    <column>prime_contract_type</column>
    <column>prime_contract_award_method</column>
    <column>prime_contract_expense_category</column>
    <column>prime_contract_industry</column>
    <column>prime_contract_pin</column>
    <column>prime_contract_apt_pin</column>
    <column>percent_covid_spending</column>
    <column>percent_other_spending</column>
    <column>prime_woman_owned_business</column>
    <column>prime_emerging_business</column>
    <column>sub_vendor</column>
    <column>sub_contract_reference_id</column>
    <column>sub_vendor_mwbe_category</column>
    <column>sub_contract_purpose</column>
    <column>sub_contract_status</column>
    <column>sub_contract_original_amount</column>
    <column>sub_contract_current_amount</column>
    <column>sub_vendor_paid_to_date</column>
    <column>sub_contract_start_date</column>
    <column>sub_contract_end_date</column>
    <column>sub_woman_owned_business</column>
    <column>sub_emerging_business</column>
    <column>document_code</column>
    <column>year</column>
    <column>contract_class</column>
  </response_columns>
</request>

Back to the top

Sample Response: Contract Transactions Active Expense (Citywide)

<response>
  <status>
    <result>success</result>
  </status>
  <request_criteria>
    <request>
      <type_of_data>Contracts</type_of_data>
      <records_from>1</records_from>
      <max_records>100</max_records>
      <search_criteria>
        <criteria>
          <name>status</name>
          <type>value</type>
          <value>active</value>
        </criteria>
        <criteria>
          <name>category</name>
          <type>value</type>
          <value>expense</value>
        </criteria>
        <criteria>
          <name>fiscal_year</name>
          <type>value</type>
          <value>2016</value>
        </criteria>
        <criteria>
          <name>agency_code</name>
          <type>value</type>
          <value>850</value>
        </criteria>
        <criteria>
          <name>vendor_code</name>
          <type>value</type>
          <value>0001466800</value>
        </criteria>
        <criteria>
          <name>contract_id</name>
          <type>value</type>
          <value>CT185020151429177</value>
        </criteria>
        <criteria>
          <name>contract_type</name>
          <type>value</type>
          <value>05</value>
        </criteria>
        <criteria>
          <name>award_method</name>
          <type>value</type>
          <value>01</value>
        </criteria>
        <criteria>
          <name>industry</name>
          <type>value</type>
          <value>1</value>
        </criteria>
        <criteria>
          <name>mwbe_category</name>
          <type>value</type>
          <value>9</value>
        </criteria>
        <criteria>
          <name>contract_includes_sub_vendors</name>
          <type>value</type>
          <value>2</value>
        </criteria>
        <criteria>
          <name>sub_contract_status</name>
          <type>value</type>
          <value>4</value>
        </criteria>
      </search_criteria>
      <response_columns>
        <column>prime_contract_id</column>
        <column>contract_includes_sub_vendors</column>
        <column>prime_vendor</column>
        <column>prime_vendor_mwbe_category</column>
        <column>prime_contract_purpose</column>
        <column>prime_contract_original_amount</column>
        <column>prime_contract_current_amount</column>
        <column>prime_vendor_spent_to_date</column>
        <column>prime_contract_start_date</column>
        <column>prime_contract_end_date</column>
        <column>prime_contract_registration_date</column>
        <column>prime_contracting_agency</column>
        <column>prime_oca_number</column>
        <column>prime_contract_version</column>
        <column>parent_contract_id</column>
        <column>prime_contract_type</column>
        <column>prime_contract_award_method</column>
        <column>prime_contract_expense_category</column>
        <column>prime_contract_industry</column>
        <column>prime_contract_pin</column>
        <column>prime_contract_apt_pin</column>
        <column>percent_covid_spending</column>
        <column>percent_other_spending</column>
        <column>prime_woman_owned_business</column>
        <column>prime_emerging_business</column>
        <column>sub_vendor</column>
        <column>sub_contract_reference_id</column>
        <column>sub_vendor_mwbe_category</column>
        <column>sub_contract_purpose</column>
        <column>sub_contract_status</column>
        <column>sub_contract_original_amount</column>
        <column>sub_contract_current_amount</column>
        <column>sub_vendor_paid_to_date</column>
        <column>sub_contract_start_date</column>
        <column>sub_contract_end_date</column>
        <column>sub_woman_owned_business</column>
        <column>sub_emerging_business</column>
        <column>document_code</column>
        <column>year</column>
        <column>contract_class</column>
      </response_columns>
    </request>
  </request_criteria>
  <result_records>
    <record_count>1</record_count>
    <contract_transactions>
      <transaction>
        <year>2016</year>
        <document_code>CT1</document_code>
        <prime_contract_id>CT185020151429177</prime_contract_id>
        <contract_includes_sub_vendors>Yes</contract_includes_sub_vendors>
        <prime_vendor>CDE AIR CONDITIONING CO INC</prime_vendor>
        <prime_vendor_mwbe_category>Non-M/WBE</prime_vendor_mwbe_category>
        <prime_contract_purpose>PLANYC Energy Audit Retrofit at Brooklyn Public Library</prime_contract_purpose>
        <prime_contract_current_amount>0</prime_contract_current_amount>
        <prime_contract_original_amount>0</prime_contract_original_amount>
        <prime_vendor_spent_to_date>0</prime_vendor_spent_to_date>
        <prime_contract_start_date>2015-08-12</prime_contract_start_date>
        <prime_contract_end_date>2017-12-31</prime_contract_end_date>
        <prime_contract_registration_date>2015-07-20</prime_contract_registration_date>
        <prime_contracting_agency>Department of Design and Construction</prime_contracting_agency>
        <prime_oca_number>103573042</prime_oca_number>
        <prime_contract_version>1</prime_contract_version>
        <parent_contract_id>-</parent_contract_id>
        <prime_contract_type>CONSTRUCTION</prime_contract_type>
        <prime_contract_award_method>COMPETITIVE SEALED BIDDING</prime_contract_award_method>
        <prime_contract_expense_category>CONSTRUCTION-BUILDINGS, POLLUTION REMEDIATION
OBLIGATIONS</prime_contract_expense_category>
        <prime_contract_industry>Construction Services</prime_contract_industry>
        <prime_contract_pin>85015B0065001C021</prime_contract_pin>
        <prime_contract_apt_pin>8502015LB0003C</prime_contract_apt_pin>
        <percent_covid_spending>-</percent_covid_spending>
        <percent_other_spending>-</percent_other_spending>
        <sub_vendor>HAILEY INSULATION CORP.</sub_vendor>
        <sub_vendor_mwbe_category>Women</sub_vendor_mwbe_category>
        <sub_contract_purpose>Insulation Work</sub_contract_purpose>
        <sub_contract_status>ACCO Approved Sub Vendor</sub_contract_status>
        <sub_contract_current_amount>14500</sub_contract_current_amount>
        <sub_contract_original_amount>14500</sub_contract_original_amount>
        <sub_vendor_paid_to_date>10508</sub_vendor_paid_to_date>
        <sub_contract_start_date>2015-09-15</sub_contract_start_date>
        <sub_contract_end_date>2017-08-10</sub_contract_end_date>
        <sub_contract_reference_id>005</sub_contract_reference_id>
        <contract_class>MIXED/SPLIT FUNDED</contract_class>
      </transaction>
    </contract_transactions>
  </result_records>
</response>

Back to the top

Sample Request: Contract Transactions Pending Expense (Citywide)

<request>
  <type_of_data >Contracts</type_of_data>
  <records_from>1</records_from>
  <max_records>5</max_records>
  <search_criteria>
    <criteria>
      <name>status</name>
      <type>value</type>
      <value>pending</value>
    </criteria>
    <criteria>
      <name>category</name>
      <type>value</type>
      <value>expense</value>
    </criteria>
    <criteria>
      <name>agency_code</name>
      <type>value</type>
      <value>850</value>
    </criteria>
     <criteria>
      <name>contract_type</name>
      <type>value</type>
      <value>05</value>
    </criteria>
    <criteria>
      <name>mwbe_category</name>
      <type>value</type>
      <value>7</value>
    </criteria>
    <criteria>
      <name>industry</name>
      <type>value</type>
      <value>1</value>
    </criteria>
  </search_criteria>
  <response_columns>
    <column>agency</column>
    <column>prime_vendor</column>
    <column>contract_id</column>
    <column>purpose</column>
    <column>parent_contract_id</column>
    <column>original_amount</column>
    <column>current_amount</column>
    <column>original_modified</column>
    <column>oca_number</column>
    <column>version</column>
    <column>received_date</column>
    <column>apt_pin</column>
    <column>pin</column>
    <column>contract_type</column>
    <column>award_method</column>
    <column>start_date</column>
    <column>end_date</column>
    <column>industry</column>
    <column>document_code</column>
    <column>prime_mwbe_category</column>
    <column>woman_owned_business</column>
    <column>emerging_business</column>
    <column>contract_class</column>
  </response_columns>
</request>

Back to the top

Sample Response: Contract Transactions Pending Expense (Citywide)

<response>
  <status>
    <result>success</result>
  </status>
  <request_criteria>
    <request>
      <type_of_data>Contracts</type_of_data>
      <records_from>1</records_from>
      <max_records>5</max_records>
      <search_criteria>
        <criteria>
          <name>status</name>
          <type>value</type>
          <value>pending</value>
        </criteria>
        <criteria>
          <name>category</name>
          <type>value</type>
          <value>expense</value>
        </criteria>
        <criteria>
          <name>agency_code</name>
          <type>value</type>
          <value>850</value>
        </criteria>
        <criteria>
          <name>contract_type</name>
          <type>value</type>
          <value>05</value>
        </criteria>
        <criteria>
          <name>mwbe_category</name>
          <type>value</type>
          <value>7</value>
        </criteria>
        <criteria>
          <name>industry</name>
          <type>value</type>
          <value>1</value>
        </criteria>
      </search_criteria>
      <response_columns>
        <column>agency</column>
        <column>prime_vendor</column>
        <column>contract_id</column>
        <column>purpose</column>
        <column>parent_contract_id</column>
        <column>original_amount</column>
        <column>current_amount</column>
        <column>original_modified</column>
        <column>oca_number</column>
        <column>version</column>
        <column>received_date</column>
        <column>apt_pin</column>
        <column>pin</column>
        <column>contract_type</column>
        <column>award_method</column>
        <column>start_date</column>
        <column>end_date</column>
        <column>industry</column>
        <column>document_code</column>
        <column>prime_mwbe_category</column>
        <column>woman_owned_business</column>
        <column>emerging_business</column>
        <column>contract_class</column>
      </response_columns>
    </request>
  </request_criteria>
  <result_records>
    <record_count>56</record_count>
    <contract_transactions>
      <transaction>
        <agency>Department of Design and Construction</agency>
        <contract_id>CTR85020151424706</contract_id>
        <prime_vendor>TISHMAN CONSTRUCTION CORPORATION OF NY</prime_vendor>
        <purpose>CM/DESIGN/BUILD FOR RESIDENTIAL COMMUNITY RECOVERY, QUEENS</purpose>
        <parent_contract_id/>
        <current_amount>481497282.00</current_amount>
        <received_date>2021-07-27</received_date>
        <apt_pin/>
        <pin>85015P0007001A002</pin>
        <contract_type>CONSTRUCTION</contract_type>
        <award_method>REQUEST FOR PROPOSAL</award_method>
        <start_date>2015-04-29</start_date>
        <end_date>2020-04-26</end_date>
        <document_code>CT1</document_code>
        <oca_number>103573042</oca_number>
        <version>52</version>
        <version>woman_owned_business</version>
        <version>emerging_business</version>
        <original_amount>281497282.00</original_amount>
        <original_modified>Modified</original_modified>
        <industry>Construction Services</industry>
        <prime_mwbe_category>Non-M/WBE</prime_mwbe_category>
        <contract_class>MIXED/SPLIT FUNDED</contract_class>
      </transaction>
      <transaction>
        <agency>Department of Design and Construction</agency>
        <contract_id>CTR85020131408259</contract_id>
        <prime_vendor>SKANSKA-TREVCON JV</prime_vendor>
        <purpose>E. 91ST STREET MARINE TRANSFER STATION</purpose>
        <parent_contract_id/>
        <current_amount>209938022.91</current_amount>
        <received_date>2021-08-13</received_date>
        <apt_pin>85013B0017001</apt_pin>
        <pin>85013B0017001C237</pin>
        <contract_type>CONSTRUCTION</contract_type>
        <award_method>COMPETITIVE BID</award_method>
        <start_date>2012-11-15</start_date>
        <end_date>2016-02-15</end_date>
        <document_code>CT1</document_code>
        <oca_number>103573042</oca_number>
        <version>239</version>
        <version>woman_owned_business</version>
        <version>emerging_business</version>
        <original_amount>181640000.00</original_amount>
        <original_modified>Modified</original_modified>
        <industry>Construction Services</industry>
        <prime_mwbe_category>Non-M/WBE</prime_mwbe_category>
        <contract_class>MIXED/SPLIT FUNDED</contract_class>
      </transaction>
      <transaction>
        <agency>Department of Design and Construction</agency>
        <contract_id>CTR85020131408259</contract_id>
        <prime_vendor>SKANSKA-TREVCON JV</prime_vendor>
        <purpose>E. 91ST STREET MARINE TRANSFER STATION</purpose>
        <parent_contract_id/>
        <current_amount>209779822.36</current_amount>
        <received_date>2021-08-18</received_date>
        <apt_pin>85013B0017001</apt_pin>
        <pin>85013B0017001C235</pin>
        <contract_type>CONSTRUCTION</contract_type>
        <award_method>COMPETITIVE BID</award_method>
        <start_date>2012-11-15</start_date>
        <end_date>2016-02-15</end_date>
        <document_code>CT1</document_code>
        <oca_number>103573042</oca_number>
        <version>240</version>
        <version>woman_owned_business</version>
        <version>emerging_business</version>
        <original_amount>181640000.00</original_amount>
        <original_modified>Modified</original_modified>
        <industry>Construction Services</industry>
        <prime_mwbe_category>Non-M/WBE</prime_mwbe_category>
        <contract_class>MIXED/SPLIT FUNDED</contract_class>
      </transaction>
      <transaction>
        <agency>Department of Design and Construction</agency>
        <contract_id>CTR85020211414552</contract_id>
        <prime_vendor>PRISMATIC DEVELOPMENT CORP.</prime_vendor>
        <purpose>STATEN ISLAND 1&3 GARAGE, PHASE 2</purpose>
        <parent_contract_id/>
        <current_amount>128161348.70</current_amount>
        <received_date>2021-08-02</received_date>
        <apt_pin>8502020TR0001C</apt_pin>
        <pin>85020B0038001C001</pin>
        <contract_type>CONSTRUCTION</contract_type>
        <award_method>COMPETITIVE BID</award_method>
        <start_date>2021-02-26</start_date>
        <end_date>2023-08-30</end_date>
        <document_code>CT1</document_code>
        <oca_number>103573042</oca_number>
        <version>2</version>
        <version>woman_owned_business</version>
        <version>emerging_business</version>
        <original_amount>281497282.00</original_amount&gt
        <original_modified>Modified</original_modified>
        <industry>Construction Services</industry>
        <prime_mwbe_category>Non-M/WBE</prime_mwbe_category>
        <contract_class>MIXED/SPLIT FUNDED</contract_class>
      </transaction>
      <transaction>
        <agency>Department of Design and Construction</agency>
        <contract_id>CTR85020171421622</contract_id>
        <prime_vendor>CAC INDUSTRIES INC</prime_vendor>
        <purpose>PELHAM PARKWAY WB/ N, PHASE 2, THE BRONX</purpose>
        <parent_contract_id/>
        <current_amount>117728131.90</current_amount>
        <received_date>2021-08-02</received_date>
        <apt_pin>8502017HW0027C</apt_pin>
        <pin>85017B0032001C012</pin>
        <contract_type>CONSTRUCTION</contract_type>
        <award_method>COMPETITIVE BID</award_method>
        <start_date>2017-04-27</start_date>
        <end_date>2020-04-26</end_date>
        <document_code>CT1</document_code>
        <oca_number>103573042</oca_number>
        <version>13</version>
        <version>woman_owned_business</version>
        <version>emerging_business</version>
        <original_amount>115271100.18</original_amount>
        <original_modified>Modified</original_modified>
        <industry>Construction Services</industry>
        <prime_mwbe_category>Non-M/WBE</prime_mwbe_category>
        <contract_class>MIXED/SPLIT FUNDED</contract_class>
      </transaction>
    </contract_transactions>
  </result_records>
</response>

Back to the top

Sample Request: Contract Transactions Active Expense (Other Government Entities - NYCEDC)

<request>
  <type_of_data>Contracts_OGE</type_of_data>
  <records_from>1</records_from>
  <max_records>150</max_records>
  <search_criteria>
    <criteria>
      <name>status</name>
      <type>value</type>
      <value>active</value>
    </criteria>
    <criteria>
      <name>category</name>
      <type>value</type>
      <value>expense</value>
    </criteria>
    <criteria>
      <name>other_government_entities_code</name>
      <type>value</type>
      <value>z81</value>
    </criteria>
    <criteria>
      <name>entity_contract_number</name>
      <type>value</type>
      <value>42770001</value>
    </criteria>
    <criteria>
      <name>prime_vendor</name>
      <type>value</type>
      <value>FOOD BANK FOR NEW YORK CITY</value>
    </criteria>
    <criteria>
      <name>contract_type</name>
      <type>value</type>
      <value>99</value>
    </criteria>
    <criteria>
      <name>contract_id</name>
      <type>value</type>
      <value>CTA180120127204112</value>
    </criteria>
    <criteria>
      <name>award_method</name>
      <type>value</type>
      <value>115</value>
    </criteria>
    <criteria>
      <name>current_amount</name>
      <type>range</type>
      <start>0</start>
      <end>507975</end>
    </criteria>
    <criteria>
      <name>start_date</name>
      <type>value</type>
      <value>2010-06-30</value>
    </criteria>
    <criteria>
      <name>end_date</name>
      <type>value</type>
      <value>2013-06-20</value>
    </criteria>
    <criteria>
      <name>budget_name</name>
      <type>value</type>
      <value>FA - Food Bank for New York City - Generator</value>
    </criteria>
    <criteria>
      <name>commodity_line</name>
      <type>value</type>
      <value>1</value>
    </criteria>
  </search_criteria>
  <response_columns>
    <column>contract_id</column>
    <column>purpose</column>
    <column>version</column>
    <column>parent_contract_id</column>
    <column>original_amount</column>
    <column>current_amount</column>
    <column>spent_to_date</column>
    <column>year</column>
    <column>other_government_entities</column>
    <column>prime_vendor</column>
    <column>contract_type</column>
    <column>award_method</column>
    <column>expense_category</column>
    <column>start_date</column>
    <column>end_date</column>
    <column>pin</column>
    <column>contract_industry</column>
    <column>document_code</column>
    <column>budget_name</column>
    <column>commodity_line</column>
    <column>entity_contract_number</column>
  </response_columns>
</request>

Back to the top

Sample Response: Contract Transactions Active Expense (Other Government Entities - NYCEDC)

<response>
  <status>
    <result>success</result>
  </status>
  <request_criteria>
    <request>
      <type_of_data>Contracts_OGE</type_of_data>
      <records_from>1</records_from>
      <max_records>150</max_records>
      <search_criteria>
        <criteria>
          <name>status</name>
          <type>value</type>
          <value>active</value>
        </criteria>
        <criteria>
          <name>category</name>
          <type>value</type>
          <value>expense</value>
        </criteria>
        <criteria>
          <name>other_government_entities_code</name>
          <type>value</type>
          <value>z81</value>
        </criteria>
        <criteria>
          <name>entity_contract_number</name>
          <type>value</type>
          <value>42770001</value>
        </criteria>
        <criteria>
          <name>prime_vendor</name>
          <type>value</type>
          <value>FOOD BANK FOR NEW YORK CITY</value>
        </criteria>
        <criteria>
          <name>contract_type</name>
          <type>value</type>
          <value>99</value>
        </criteria>
        <criteria>
          <name>contract_id</name>
          <type>value</type>
          <value>CTA180120127204112</value>
        </criteria>
        <criteria>
          <name>award_method</name>
          <type>value</type>
          <value>115</value>
        </criteria>
        <criteria>
          <name>current_amount</name>
          <type>range</type>
          <start>0</start>
          <end>507975</end>
        </criteria>
        <criteria>
          <name>start_date</name>
          <type>value</type>
          <value>2010-06-30</value>
        </criteria>
        <criteria>
          <name>end_date</name>
          <type>value</type>
          <value>2013-06-20</value>
        </criteria>
        <criteria>
          <name>budget_name</name>
          <type>value</type>
          <value>FA - Food Bank for New York City - Generator</value>
        </criteria>
        <criteria>
          <name>commodity_line</name>
          <type>value</type>
          <value>1</value>
        </criteria>
      </search_criteria>
      <response_columns>
        <column>contract_id</column>
        <column>purpose</column>
        <column>version</column>
        <column>parent_contract_id</column>
        <column>original_amount</column>
        <column>current_amount</column>
        <column>spent_to_date</column>
        <column>year</column>
        <column>other_government_entities</column>
        <column>prime_vendor</column>
        <column>contract_type</column>
        <column>award_method</column>
        <column>expense_category</column>
        <column>start_date</column>
        <column>end_date</column>
        <column>pin</column>
        <column>contract_industry</column>
        <column>document_code</column>
        <column>budget_name</column>
        <column>commodity_line</column>
        <column>entity_contract_number</column>
      </response_columns>
    </request>
  </request_criteria>
  <result_records>
    <record_count>1</record_count>
    <contract_transactions>
      <transaction>
        <other_government_entities>NEW YORK CITY ECONOMIC DEVELOPMENT
CORPORATION</other_government_entities>
        <prime_vendor>To Be Announced</prime_vendor>
        <contract_id>CTA180120127204981</contract_id>
        <version>61</version>
        <year>2014</year>
        <parent_contract_id>MMA180120126200316</parent_contract_id>
        <purpose>Goldwater North 47580001</purpose>
        <original_amount>17121901.01</original_amount>
        <current_amount>181027435.9</current_amount>
        <spent_to_date>179340125.14</spent_to_date>
        <pin>80111S0010001</pin>
        <contract_type>99</contract_type>
        <award_method>MULTIPLE AWARDS</award_method>
        <expense_category>CONSTRUCTION-BUILDINGS, DEMOLITION, DESIGN-CONSULTANT-BUILDINGS, IOTB CONSTRUCTION</expense_category>
        <start_date>2012-02-01</start_date>
        <end_date>2014-03-04</end_date>
        <document_code>CTA1</document_code>
        <contract_industry>Standardized Services</contract_industry>
        <commodity_line>107</commodity_line>
        <entity_contract_number>47580001</entity_contract_number>
        <budget_name>CONSTRUCTION OF NEW GOLDWATER NORTH SNF</budget_name>
      </transaction>
    </contract_transactions>
  </result_records>
</response>

Back to the top

Sample Request: Contract Transactions (Other Government Entities - NYCHA)

<request>
  <type_of_data>Contracts_NYCHA</type_of_data>
  <records_from>1</records_from>
  <max_records>10</max_records>
  <search_criteria>
    <criteria>
      <name>fiscal_year</name>
      <type>value</type>
      <value>2018</value>
    </criteria>
    <criteria>
      <name>contract_id</name>
      <type>value</type>
      <value>BA1725099</value>
    </criteria>
    <criteria>
      <name>vendor_code</name>
      <type>value</type>
      <value>256482</value>
    </criteria>
    <criteria>
      <name>contract_type</name>
      <type>value</type>
      <value>1570</value>
    </criteria>
    <criteria>
      <name>award_method</name>
      <type>value</type>
      <value>85273</value>
    </criteria>
    <criteria>
      <name>industry</name>
      <type>value</type>
      <value>040</value>
    </criteria>
    <criteria>
      <name>current_amount</name>
      <type>range</type>
      <start>0</start>
      <end>100000</end>
    </criteria>
    <criteria>
      <name>start_date</name>
      <type>range</type>
      <start>2017-01-01</start>
      <end>2019-01-01</end>
    </criteria>
    <criteria>
      <name>end_date</name>
      <type>range</type>
      <start>2017-01-01</start>
      <end>2020-01-01</end>
    </criteria>
    <criteria>
      <name>pin</name>
      <type>value</type>
      <value>18878593</value>
    </criteria>
    <criteria>
      <name>purpose</name>
      <type>value</type>
      <value>unity</value>
    </criteria>
  </search_criteria>
  <response_columns>
    <column>contract_id</column>
    <column>purchase_order_type</column>
    <column>record_type</column>
    <column>number_of_releases</column>
    <column>release_number</column>
    <column>line_number</column>
    <column>item_category</column>
    <column>item_description</column>
    <column>quantity_ordered</column>
    <column>shipment_number</column>
    <column>responsibility_center</column>
    <column>start_date</column>
    <column>end_date</column>
    <column>approved_date</column>
    <column>line_original_amount</column>
    <column>line_current_amount</column>
    <column>line_invoiced_amount</column>
    <column>release_original_amount</column>
    <column>release_current_amount</column>
    <column>release_invoiced_amount</column>
    <column>contract_original_amount</column>
    <column>contract_current_amount</column>
    <column>contract_invoiced_amount</column>
    <column>purpose</column>
    <column>vendor</column>
    <column>location</column>
    <column>contract_type</column>
    <column>award_method</column>
    <column>grant_name</column>
    <column>expenditure_type</column>
    <column>industry</column>
    <column>funding_source</column>
    <column>program</column>
    <column>project</column>
    <column>year</column>
  </response_columns>
</request>

Back to the top

Sample Response: Contract Transactions (Other Government Entities - NYCHA)

<response>
  <status>
    <result>success</result>
  </status>
  <request_criteria>
    <request>
      <type_of_data>Contracts_NYCHA</type_of_data>
      <records_from>1</records_from>
      <max_records>10</max_records>
      <search_criteria>
        <criteria>
          <name>fiscal_year</name>
          <type>value</type>
          <value>2018</value>
        </criteria>
        <criteria>
          <name>contract_id</name>
          <type>value</type>
          <value>BA1725099</value>
        </criteria>
        <criteria>
          <name>vendor_code</name>
          <type>value</type>
          <value>256482</value>
        </criteria>
        <criteria>
          <name>contract_type</name>
          <type>value</type>
          <value>1570</value>
        </criteria>
        <criteria>
          <name>award_method</name>
          <type>value</type>
          <value>85273</value>
        </criteria>
        <criteria>
          <name>industry</name>
          <type>value</type>
          <value>040</value>
        </criteria>
        <criteria>
          <name>current_amount</name>
          <type>range</type>
          <start>0</start>
          <end>100000</end>
        </criteria>
        <criteria>
          <name>start_date</name>
          <type>range</type>
          <start>2017-01-01</start>
          <end>2019-01-01</end>
        </criteria>
        <criteria>
          <name>end_date</name>
          <type>range</type>
          <start>2017-01-01</start>
          <end>2020-01-01</end>
        </criteria>
        <criteria>
          <name>pin</name>
          <type>value</type>
          <value>18878593</value>
        </criteria>
        <criteria>
          <name>purpose</name>
          <type>value</type>
          <value>unity</value>
        </criteria>
      </search_criteria>
      <response_columns>
        <column>contract_id</column>
        <column>purchase_order_type</column>
        <column>record_type</column>
        <column>number_of_releases  </column>
        <column>release_number</column>
        <column>line_number</column>
        <column>item_category</column>
        <column>item_description</column>
        <column>quantity_ordered</column>
        <column>shipment_number</column>
        <column>responsibility_center</column>
        <column>start_date</column>
        <column>end_date</column>
        <column>approved_date</column>
        <column>line_original_amount</column>
        <column>line_current_amount</column>
        <column>line_invoiced_amount</column>
        <column>release_original_amount</column>
        <column>release_current_amount</column>
        <column>release_invoiced_amount</column>
        <column>contract_original_amount</column>
        <column>contract_current_amount</column>
        <column>contract_invoiced_amount</column>
        <column>purpose</column>
        <column>vendor</column>
        <column>location</column>
        <column>contract_type</column>
        <column>award_method</column>
        <column>grant_name</column>
        <column>expenditure_type</column>
        <column>industry</column>
        <column>funding_source</column>
        <column>program</column>
        <column>project</column>
        <column>year</column>
      </response_columns>
    </request>
  </request_criteria>
  <result_records>
  <record_count>1</record_count>
    <contract_transactions>
      <transaction>
        <year>2018</year>
        <contract_id>BA1725099</contract_id>
        <purchase_order_type>BLANKET AGREEMENT</purchase_order_type>
        <record_type>Agreement</record_type>
        <number_of_releases>150<number_of_releases>
        <quantity_ordered/>
        <release_number/>
        <line_number/>
        <item_category>-</item_category>
        <item_description>-</item_description>
        <shipment_number/>
        <start_date>2017-09-12</start_date>
        <end_date>2019-03-25</end_date>
        <approved_date/>
        <line_current_amount/>
        <line_original_amount/>
        <line_invoiced_amount/>
        <release_current_amount/>
        <release_original_amount/>
        <release_invoiced_amount/>
        <contract_current_amount>86975.06</contract_current_amount>
        <contract_original_amount>86975.06</contract_original_amount>
        <contract_invoiced_amount>81645.43</contract_invoiced_amount>
        <purpose>Unity Plaza (17, 24 & 25A), Unity Plaza (4-27), Fiorentino & Long Island Baptist,
        Brooklyn - Installation of Vinyl Floor Tile in Apartments - (TECHNI039609 - N. Bose)</purpose>
        <vendor>KUMAR CONTRACTING CORP</vendor>
        <location>-</location>
        <contract_type>Tile, Vinyl Floor Tile - Apartments</contract_type>
        <award_method>SEALED BID</award_method>
        <grant_name>-</grant_name>
        <expenditure_type>-</expenditure_type>
        <industry>Service</industry>
        <funding_source>-</funding_source>
        <responsibility_center>-</responsibility_center>
        <program>-</program>
        <project>-</project>
      </transaction>
    </contract_transactions>
  </result_records>
</response>

Back to the top

Status Codes and Messages

Status messages are categorized and displayed as status codes with short description for the user to understand the cause of the error. In case of an error no result records will be displayed and the error message will be displayed inside the <message> XML element as shown below. See here for list of status codes and messages

Example: Result is Success

<status>
  <result>success</result>
  <messages>
    <message>
      <code>1</code>
      <description>The status is still a success but there are no results found for given search criteria</description>
    </message>
  </messages>
</status>

Example: Result is Failure

 <status>
  <result>error</result>
  <messages>
    <message>
      <code>1000</code>
      <description>Required parameter 'type_of_data' is missing</description>
    </message>
  </messages>
</status>

Back to the top

Status Code Description
1 The status is still a success but there are no results found for given search criteria.
1000 Required parameter 'type_of_data' is missing.
1001 Invalid value 'BudgetRequest' is provided for 'type_of_data'. Valid values are Budget, Spending, and Revenue.
1002 Provided value '2.1' for 'records_from' is not an integer. Valid value is a number values without decimal places
1003 Total number of requested records '1001' exceeds allowed limit of '1000' records
1101 Provided request parameter 'date' is not valid for 'Budget' domain. Valid values are 'fiscal_year, agency_code, department_code, budget_code, expense_category, adopted_budget, current_modified_budget, pre_encumbered, encumbered, cash_expense, post_adjustment, accrued_expense
1102 No value is provided for request parameter 'fiscal_year'.
1103 Provided value '20000' for request parameter 'fiscal_year' is not valid year.
1104 Provided 'start' value '200s' for request parameter 'adopted_budget' is not valid amount.
1105 Provided start value '1000' is greater than end value '500' for request parameter 'adopted_budget'.
1106 Provided response column 'agencyname' value is not allowed for 'Budget' domain. Valid values are 'agency_name, department_name, expense_category, budget_code, budget_code_name, current_modified_budget, adopted_budget, pre_encumbered, encumbered, cash_expense, post_adjustment, accrued_expense'.
1108 Provided value 'abcd' for request parameter 'agency_code' exceeds maximum allowed '3' characters.
1109 Provided 'start' value '1234567890' for request parameter 'adopted_budget' exceeds maximum allowed '5' characters.
1110 Request parameter 'agency_code' do not support range values.
 

Overview

In July of 2010 the New York City Comptroller’s Office launched Checkbook NYC, an online transparency tool that for the first time placed the City’s day-to-day spending in the public domain. Using an intuitive dashboard approach that combines a series of graphs and user-friendly tables, Checkbook NYC provides up-to-date information about the City's financial condition.

Checkbook NYC has been ranked the top transparency tool in the nation for tracking government spending by the United States Public Interest Research Group, and was named New York City 2013 “Best External Application” by Government Technology Magazine.


 

Spotlight