Skip to content

Latest commit

 

History

History
289 lines (186 loc) · 8.46 KB

MunicipalityApi.md

File metadata and controls

289 lines (186 loc) · 8.46 KB
Raw

MunicipalityApi

All URIs are relative to https://api-v2.intrinio.com

Method HTTP request Description
getAllMunicipalities GET /municipalities All Municipalities
getMunicipalityById GET /municipalities/{id} Municipality by ID
getMunicipalityFinancials GET /municipalities/{id}/financials Financials for a Municipality

getAllMunicipalities

View Intrinio API Documentation

ApiResponseMunicipalities getAllMunicipalities(hasFinancials, governmentName, governmentType, areaName, areaType, city, state, zipcode, populationGreaterThan, populationLessThan, enrollmentGreaterThan, enrollmentLessThan, nextPage)

All Municipalities

Returns all Municipalities. When parameters are specified, returns matching municipalities.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    MunicipalityApi municipalityApi = new MunicipalityApi();
    Boolean hasFinancials = null;
    String governmentName = null;
    String governmentType = null;
    String areaName = null;
    String areaType = null;
    String city = null;
    String state = null;
    BigDecimal zipcode = null;
    BigDecimal populationGreaterThan = null;
    BigDecimal populationLessThan = null;
    BigDecimal enrollmentGreaterThan = null;
    BigDecimal enrollmentLessThan = null;
    String nextPage = null;
    ApiResponseMunicipalities result = municipalityApi.getAllMunicipalities(hasFinancials, governmentName, governmentType, areaName, areaType, city, state, zipcode, populationGreaterThan, populationLessThan, enrollmentGreaterThan, enrollmentLessThan, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
hasFinancials Boolean Return municipalities with financials [optional]  
governmentName String Return municipalities with a government name matching the given query [optional]  
governmentType String Return municipalities with the given government type [optional]  
areaName String Return municipalities with an area name matching the given query [optional]  
areaType String Return municipalities with the given area type [optional] [enum: Borough, Census Borough, Census County, Census Division, Census Parish, City, City And County, County, Municipality, Parish]  
city String Return municipalities in the given city [optional]  
state String Return municipalities in the given state [optional]  
zipcode BigDecimal Return municipalities in the given zipcode [optional]  
populationGreaterThan BigDecimal Return municipalities with a population greater than the given number [optional]  
populationLessThan BigDecimal Return municipalities with a population less than the given number [optional]  
enrollmentGreaterThan BigDecimal Return municipalities with an enrollment greater than the given number [optional]  
enrollmentLessThan BigDecimal Return municipalities with an enrollment less than the given number [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseMunicipalities

getMunicipalityById

View Intrinio API Documentation

Municipality getMunicipalityById(id)

Municipality by ID

Returns the Municipality with the given ID

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    MunicipalityApi municipalityApi = new MunicipalityApi();
    String id = "mun_Xn7x4z";
    Municipality result = municipalityApi.getMunicipalityById(id);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
id String An Intrinio ID of a Municipality  

Return type

Municipality

getMunicipalityFinancials

View Intrinio API Documentation

ApiResponseMunicipalitiyFinancials getMunicipalityFinancials(id, fiscalYear)

Financials for a Municipality

Returns financial statement data for the Municipality with the given ID

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    MunicipalityApi municipalityApi = new MunicipalityApi();
    String id = "mun_Xn7x4z";
    BigDecimal fiscalYear = null;
    ApiResponseMunicipalitiyFinancials result = municipalityApi.getMunicipalityFinancials(id, fiscalYear);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
id String An Intrinio ID of a Municipality  
fiscalYear BigDecimal Return financials for the given fiscal year [optional]  

Return type

ApiResponseMunicipalitiyFinancials