Initial commit
This commit is contained in:
commit
3f997f7d84
GPG Key ID:
EF4B922DB85DC9DE
15
LICENSE
Normal file
15
LICENSE
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2025, acidvegas <acid.vegas@acid.vegas>
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
69
README.md
Normal file
69
README.md
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
# FCC Form 499 API Client
|
||||||
|
|
||||||
|
Python client for interacting with the FCC Form 499 Filer Database API.
|
||||||
|
|
||||||
|
This client provides a simple interface to search the database of telecommunications carriers, interconnected VoIP providers, and other providers of interstate telecommunications.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The FCC Form 499 Filer Database is an identification system for all interstate telecommunications carriers, all interconnected VoIP providers, and certain other providers of interstate telecommunications. These providers are required to register with the Commission using the Telecommunications Reporting Worksheet (FCC Form 499-A) and update their registration on a periodic basis.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```python
|
||||||
|
from fcc_form499 import FCC499Client, States, CommunicationType
|
||||||
|
|
||||||
|
# Create client instance
|
||||||
|
client = FCC499Client()
|
||||||
|
|
||||||
|
# Search for providers in Montana with communication type "Other Mobile"
|
||||||
|
result = client.search(
|
||||||
|
states=[States.MONTANA],
|
||||||
|
comm_type=CommunicationType.OTHM
|
||||||
|
)
|
||||||
|
|
||||||
|
print(result)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Search Parameters
|
||||||
|
| Parameter | Description |
|
||||||
|
|------------------|-------------------------------------------------------|
|
||||||
|
| filer_id | FCC Form 499 Filer ID Number |
|
||||||
|
| legal_name | Legal or Trade Name of Filer |
|
||||||
|
| frn | Registration Number (CORESID) |
|
||||||
|
| states | List of states to search *(use States enum)* |
|
||||||
|
| comm_type | Primary Communications Type *(use CommunicationType)* |
|
||||||
|
| logical_operator | Logical operator for joining states *(AND/OR)* |
|
||||||
|
|
||||||
|
### Communication Types
|
||||||
|
| Type | Description |
|
||||||
|
|------|-------------------------------------|
|
||||||
|
| ABS | Audio Bridge Service |
|
||||||
|
| ALLD | All Distance |
|
||||||
|
| COAX | Cable TV provider of local exchange |
|
||||||
|
| VOIP | Interconnected VoIP |
|
||||||
|
| CAP | CAP/LEC |
|
||||||
|
| CEL | Cellular/PCS/SMR |
|
||||||
|
| DAT | Wireless Data |
|
||||||
|
| IXC | Interexchange Carrier |
|
||||||
|
| LEC | Incumbent Local Exchange Carrier |
|
||||||
|
| LRES | Local Reseller |
|
||||||
|
| OSP | Operator Service Provider |
|
||||||
|
| OTHL | Other Local |
|
||||||
|
| OTHM | Other Mobile |
|
||||||
|
| OTHT | Other Toll |
|
||||||
|
| PAG | Paging & Messaging |
|
||||||
|
| PAY | Payphone Service Provider |
|
||||||
|
| PRE | Prepaid Card |
|
||||||
|
| PRIV | Private Service Provider |
|
||||||
|
| SAT | Satellite |
|
||||||
|
| SMR | SMR (dispatch) |
|
||||||
|
| TEN | Shared Tenant Service Provider |
|
||||||
|
| TRES | Toll Reseller |
|
||||||
|
|
||||||
|
## References
|
||||||
|
* [FCC Form 499 Filer Database](http://apps.fcc.gov/cgb/form499/499a.cfm)
|
||||||
|
* [FCC Form 499-A](https://www.fcc.gov/formpage.html)
|
||||||
|
* [USAC Online Filing](http://forms.universalservice.org)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
###### Mirrors for this repository: [acid.vegas](https://git.acid.vegas/fcc-form499-api) • [SuperNETs](https://git.supernets.org/acidvegas/fcc-form499-api) • [GitHub](https://github.com/acidvegas/fcc-form499-api) • [GitLab](https://gitlab.com/acidvegas/fcc-form499-api) • [Codeberg](https://codeberg.org/acidvegas/fcc-form499-api)
|
||||||
167
fcc_form499.py
Normal file
167
fcc_form499.py
Normal file
@ -0,0 +1,167 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
# FCC Form499 API Client - Developed by acidvegas in Python (https://git.acid.vegas/fcc-form499-api)
|
||||||
|
|
||||||
|
from enum import Enum
|
||||||
|
import urllib.error
|
||||||
|
import urllib.parse
|
||||||
|
import urllib.request
|
||||||
|
|
||||||
|
class States(str, Enum):
|
||||||
|
'''List of valid states'''
|
||||||
|
|
||||||
|
ALABAMA = 'alabama'
|
||||||
|
ALASKA = 'alaska'
|
||||||
|
AMERICAN_SAMOA = 'american_samoa'
|
||||||
|
ARIZONA = 'arizona'
|
||||||
|
ARKANSAS = 'arkansas'
|
||||||
|
CALIFORNIA = 'california'
|
||||||
|
COLORADO = 'colorado'
|
||||||
|
CONNECTICUT = 'connecticut'
|
||||||
|
DELAWARE = 'delaware'
|
||||||
|
DISTRICT_OF_COLUMBIA = 'district_of_columbia'
|
||||||
|
FLORIDA = 'florida'
|
||||||
|
GEORGIA = 'georgia'
|
||||||
|
GUAM = 'guam'
|
||||||
|
HAWAII = 'hawaii'
|
||||||
|
IDAHO = 'idaho'
|
||||||
|
ILLINOIS = 'illinois'
|
||||||
|
INDIANA = 'indiana'
|
||||||
|
IOWA = 'iowa'
|
||||||
|
JOHNSTON_ATOLL = 'johnston_atoll'
|
||||||
|
KANSAS = 'kansas'
|
||||||
|
KENTUCKY = 'kentucky'
|
||||||
|
LOUISIANA = 'louisiana'
|
||||||
|
MAINE = 'maine'
|
||||||
|
MARYLAND = 'maryland'
|
||||||
|
MASSACHUSETTS = 'massachusetts'
|
||||||
|
MICHIGAN = 'michigan'
|
||||||
|
MIDWAY_ATOLL = 'midway_atoll'
|
||||||
|
MINNESOTA = 'minnesota'
|
||||||
|
MISSISSIPPI = 'mississippi'
|
||||||
|
MISSOURI = 'missouri'
|
||||||
|
MONTANA = 'montana'
|
||||||
|
NEBRASKA = 'nebraska'
|
||||||
|
NEVADA = 'nevada'
|
||||||
|
NEW_HAMPSHIRE = 'new_hampshire'
|
||||||
|
NEW_JERSEY = 'new_jersey'
|
||||||
|
NEW_MEXICO = 'new_mexico'
|
||||||
|
NEW_YORK = 'new_york'
|
||||||
|
NORTH_CAROLINA = 'north_carolina'
|
||||||
|
NORTH_DAKOTA = 'north_dakota'
|
||||||
|
NORTHERN_MARIANA_ISLANDS = 'northern_mariana_islands'
|
||||||
|
OHIO = 'ohio'
|
||||||
|
OKLAHOMA = 'oklahoma'
|
||||||
|
OREGON = 'oregon'
|
||||||
|
PENNSYLVANIA = 'pennsylvania'
|
||||||
|
PUERTO_RICO = 'puerto_rico'
|
||||||
|
RHODE_ISLAND = 'rhode_island'
|
||||||
|
SOUTH_CAROLINA = 'south_carolina'
|
||||||
|
SOUTH_DAKOTA = 'south_dakota'
|
||||||
|
TENNESSEE = 'tennessee'
|
||||||
|
TEXAS = 'texas'
|
||||||
|
UTAH = 'utah'
|
||||||
|
US_VIRGIN_ISLANDS = 'us_virgin_islands'
|
||||||
|
VERMONT = 'vermont'
|
||||||
|
VIRGINIA = 'virginia'
|
||||||
|
WAKE_ISLAND = 'wake_island'
|
||||||
|
WASHINGTON = 'washington'
|
||||||
|
WEST_VIRGINIA = 'west_virginia'
|
||||||
|
WISCONSIN = 'wisconsin'
|
||||||
|
WYOMING = 'wyoming'
|
||||||
|
|
||||||
|
|
||||||
|
class CommunicationType(str, Enum):
|
||||||
|
'''List of valid communication types'''
|
||||||
|
|
||||||
|
ABS = 'ABS' # Audio Bridge Service
|
||||||
|
ALLD = 'ALLD' # All Distance
|
||||||
|
COAX = 'COAX' # Cable TV provider of local exchange
|
||||||
|
VOIP = 'VOIP' # Interconnected VoIP
|
||||||
|
CAP = 'CAP' # CAP/LEC
|
||||||
|
CEL = 'CEL' # Cellular/PCS/SMR
|
||||||
|
DAT = 'DAT' # Wireless Data
|
||||||
|
IXC = 'IXC' # Interexchange Carrier
|
||||||
|
LEC = 'LEC' # Incumbent Local Exchange Carrier
|
||||||
|
LRES = 'LRES' # Local Reseller
|
||||||
|
OSP = 'OSP' # Operator Service Provider
|
||||||
|
OTHL = 'OTHL' # Other Local
|
||||||
|
OTHM = 'OTHM' # Other Mobile
|
||||||
|
OTHT = 'OTHT' # Other Toll
|
||||||
|
PAG = 'PAG' # Paging & Messaging
|
||||||
|
PAY = 'PAY' # Payphone Service Provider
|
||||||
|
PRE = 'PRE' # Prepaid Card
|
||||||
|
PRIV = 'PRIV' # Private Service Provider
|
||||||
|
SAT = 'SAT' # Satellite
|
||||||
|
SMR = 'SMR' # SMR (dispatch)
|
||||||
|
TEN = 'TEN' # Shared Tenant Service Provider
|
||||||
|
TRES = 'TRES' # Toll Reseller
|
||||||
|
|
||||||
|
|
||||||
|
class LogicalOperator(str, Enum):
|
||||||
|
'''List of valid logical operators'''
|
||||||
|
|
||||||
|
AND = 'AND'
|
||||||
|
OR = 'OR'
|
||||||
|
|
||||||
|
|
||||||
|
class FCC499Client:
|
||||||
|
'''FCC Form 499 API Client'''
|
||||||
|
|
||||||
|
# FCC Form 499 API URL
|
||||||
|
BASE_URL = 'http://apps.fcc.gov/cgb/form499/499results.cfm'
|
||||||
|
|
||||||
|
|
||||||
|
def search(self, filer_id=None, legal_name=None, frn=None, states=None, comm_type=None, logical_operator=LogicalOperator.AND):
|
||||||
|
'''
|
||||||
|
Search the FCC Form 499 Filer Database
|
||||||
|
|
||||||
|
:param filer_id: str - The FCC Form 499 Filer ID
|
||||||
|
:param legal_name: str - The legal name of the filer
|
||||||
|
:param frn: str - The FRN of the filer
|
||||||
|
:param states: list[States] - The states to search for
|
||||||
|
:param comm_type: CommunicationType - The communication type to search for
|
||||||
|
:param logical_operator: LogicalOperator - The logical operator to use
|
||||||
|
'''
|
||||||
|
|
||||||
|
# Set the default parameters
|
||||||
|
params = {'XML': 'TRUE', 'R1': logical_operator.value}
|
||||||
|
|
||||||
|
# Add the parameters to the request
|
||||||
|
if filer_id:
|
||||||
|
params['FilerID'] = filer_id
|
||||||
|
if legal_name:
|
||||||
|
params['LegalName'] = legal_name
|
||||||
|
if frn:
|
||||||
|
params['frn'] = frn
|
||||||
|
if states:
|
||||||
|
params['state'] = ','.join(state.value for state in states)
|
||||||
|
if comm_type:
|
||||||
|
params['comm_type'] = comm_type.value
|
||||||
|
|
||||||
|
# Build the URL
|
||||||
|
url = f'{self.BASE_URL}?{urllib.parse.urlencode(params)}'
|
||||||
|
|
||||||
|
# Make the request
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(url) as response:
|
||||||
|
if response.status != 200:
|
||||||
|
raise ValueError(f'API request failed with status code: {response.status}')
|
||||||
|
return response.read().decode('utf-8')
|
||||||
|
except urllib.error.HTTPError as e:
|
||||||
|
raise ValueError(f'API request failed with status code: {e.code}')
|
||||||
|
except urllib.error.URLError as e:
|
||||||
|
raise ValueError(f'API request failed: {str(e)}')
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
client = FCC499Client()
|
||||||
|
|
||||||
|
try:
|
||||||
|
result = client.search(states=[States.MONTANA], comm_type=CommunicationType.OTHM)
|
||||||
|
print(result)
|
||||||
|
except Exception as e:
|
||||||
|
print(f'Error: {str(e)}')
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
Loading…
Reference in New Issue
Block a user