fcc-form499-api

- Unnamed repository; edit this file 'description' to name the repository.
git clone git://git.acid.vegas/-c.git
README.md (3894B)
      1 # FCC Form 499 API Client
      2 
      3 Python client for interacting with the FCC Form 499 Filer Database API. 
      4 
      5 This client provides a simple interface to search the database of telecommunications carriers, interconnected VoIP providers, and other providers of interstate telecommunications.
      6 
      7 ## Overview
      8 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.
      9 
     10 ## Usage
     11 ```python
     12 from fcc_form499 import FCC499Client, States, CommunicationType
     13 
     14 # Create client instance
     15 client = FCC499Client()
     16 
     17 # Search for providers in Montana with communication type "Other Mobile"
     18 result = client.search(
     19     states=[States.MONTANA],
     20     comm_type=CommunicationType.OTHM
     21 )
     22 
     23 print(result)
     24 ```
     25 
     26 ### Search Parameters
     27 | Parameter        | Description                                           |
     28 |------------------|-------------------------------------------------------|
     29 | filer_id         | FCC Form 499 Filer ID Number                          |
     30 | legal_name       | Legal or Trade Name of Filer                          |
     31 | frn              | Registration Number (CORESID)                         |
     32 | states           | List of states to search *(use States enum)*          |
     33 | comm_type        | Primary Communications Type *(use CommunicationType)* |
     34 | logical_operator | Logical operator for joining states *(AND/OR)*        |
     35 
     36 ### Communication Types
     37 | Type | Description                         |
     38 |------|-------------------------------------|
     39 | ABS  | Audio Bridge Service                |
     40 | ALLD | All Distance                        |
     41 | COAX | Cable TV provider of local exchange |
     42 | VOIP | Interconnected VoIP                 |
     43 | CAP  | CAP/LEC                             |
     44 | CEL  | Cellular/PCS/SMR                    |
     45 | DAT  | Wireless Data                       |
     46 | IXC  | Interexchange Carrier               |
     47 | LEC  | Incumbent Local Exchange Carrier    |
     48 | LRES | Local Reseller                      |
     49 | OSP  | Operator Service Provider           |
     50 | OTHL | Other Local                         |
     51 | OTHM | Other Mobile                        |
     52 | OTHT | Other Toll                          |
     53 | PAG  | Paging & Messaging                  |
     54 | PAY  | Payphone Service Provider           |
     55 | PRE  | Prepaid Card                        |
     56 | PRIV | Private Service Provider            |
     57 | SAT  | Satellite                           |
     58 | SMR  | SMR (dispatch)                      |
     59 | TEN  | Shared Tenant Service Provider      |
     60 | TRES | Toll Reseller                       |
     61 
     62 ## Errors
     63 | Error code | Description                                 |
     64 |------------|---------------------------------------------|
     65 | 1          | Invalid state value                         |
     66 | 2          | Could not execute query. Invalid parameters |
     67 | 3          | No results found. Check Query parameters.   |
     68 | 4          | Invalid value for FRN.                      |
     69 | 5          | Invalid value for Filer ID.                 |
     70 | 6          | Invalid value for Communications Type.      |
     71 | 7          | Wrong Request Method. Only GET is allowed.  |
     72 
     73 ## References
     74 * [FCC Form 499 Filer Database](http://apps.fcc.gov/cgb/form499/499a.cfm)
     75 * [FCC Form 499-A](https://www.fcc.gov/formpage.html)
     76 * [USAC Online Filing](http://forms.universalservice.org)
     77 
     78 ___
     79 
     80 ###### 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)