OKCountyRecords API

https://okcountyrecords.com/api/v1/documentation
Admin
OKCountyRecords API provides programmatic access to Oklahoma county clerk records, enabling users to...
Tokens:10,685
Snippets:56
Trust Score:8.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Report a Problem API Request Example

Source: https://okcountyrecords.com/api/v1/documentation/report-a-problem

This example demonstrates how to make a GET request to the 'report-a-problem' API endpoint. It includes required parameters like county, book, and beginning_page, along with optional parameters for specifying the type of problem and email/webhook notifications for resolution. The example also shows the expected JSON response for a successful request.

```http
GET https://okcountyrecords.com/api/v1/report-a-problem?county=Adair&book=293&beginning_page=737&incorrect_images=1&return_email=john.doe@someservice.com&return_webhook=http://mysite.com/problem-resolution

{
	"success": true
}
```

--------------------------------

### API Search Request Example

Source: https://okcountyrecords.com/api/v1/documentation/search

An example of how to construct a search request to the okcountyrecords API v1. This URL targets a specific county, book, and page to retrieve record information.

```HTTP
https://okcountyrecords.com/api/v1/search?county=Alfalfa&book=794&page=608
```

--------------------------------

### API Request Example: Problem Reports

Source: https://okcountyrecords.com/api/v1/documentation/problem-reports

Example of an HTTP GET request to the API Problem Reports resource. This request filters for resolved reports.

```HTTP
GET https://okcountyrecords.com/api/v1/problem-reports?resolved=1
```

--------------------------------

### API Response Example: Problem Reports

Source: https://okcountyrecords.com/api/v1/documentation/problem-reports

Example JSON response from the API Problem Reports resource, showing details of a single problem report.

```JSON
[
	{
		"county": "Adair",
		"book": "000293",
		"beginning_page": "0737",
		"created_date": "2018-05-01 14:01:20.712932",
		"resolved": true,
		"resolved_date": "2018-05-01 14:01:53.743512",
		"resolution": "manually-fixed",
		"detail_url": "\/detail\/adair\/1996-035627\/2221655",
		"return_email": "john.doe@someservice.com",
		"return_webhook": "http://mysite.com/problem-resolved",
		"description": "The grantor's name is misspelled.",
		"incorrect_legal_description": false,
		"incorrect_images": false,
		"incorrect_instrument_type": false,
		"incorrect_parties": true
	}
]
```

--------------------------------

### Get List of Books by County - API Response Example

Source: https://okcountyrecords.com/api/v1/documentation/books

This snippet shows an example of the JSON response when requesting a list of books for a county. Each object represents a book and includes its number, page count, and a link to search instruments within that book.

```JSON
[
    {
        "number": "000139",
        "number_of_pages": 930,
        "search_address": "\/api\/v1\/instruments?county=Adair&book=000139"
    }
]
```

--------------------------------

### Example County Data Response

Source: https://okcountyrecords.com/api/v1/documentation/counties

An example JSON response when querying the API for county data. This structure includes details like county code, name, address, contact information, and data availability dates.

```JSON
[
    {
        "code": 5,
        "name": "Beckham",
        "official": "Leasa Hartman",
        "address1": "Beckham County Courthouse",
        "address2": "P.O. Box 428",
        "city": "Sayre",
        "state": "OK",
        "postal": "73662",
        "phone": "(580) 928-3383",
        "email": "bkcoclerk@cableone.net",
        "hours": "8:00am - 4:00pm",
        "website": "http:\/\/beckham.okcounties.org",
        "data_beginning_date": "1990-05-22",
        "image_beginning_date": "1990-05-30",
        "searching_enabled": 1,
        "images_enabled": 1,
        "copies_enabled": 1,
        "tokens_per_page": 1,
        "number_of_instruments": 238642,
        "number_of_images": 1162628,
        "comments_enabled": 0
    }
]
```

--------------------------------

### List County Offices API Response Example

Source: https://okcountyrecords.com/api/v1/documentation/offices

An example JSON response for the List County Offices API endpoint, showing the structure of office data including code, county name, and office name.

```JSON
[
    {
        "code": 1,
        "county": "Arkansas",
        "name": "Southern District (DeWitt)"
    },
    {
        "code": 2,
        "county": "Arkansas",
        "name": "Nothern District (Stuttgart)"
    }
]
```

--------------------------------

### API Response Example

Source: https://okcountyrecords.com/api/v1/documentation/search

A JSON object representing the response from the okcountyrecords API v1 after a successful search. It includes detailed information about a specific instrument, its parties, legal descriptions, and associated images.

```JSON
[
    {
        "county": "Alfalfa",
        "office_code": null,
        "type": "Mortgage",
        "record_type": "I",
        "series": "2016",
        "number": "084238",
        "book": "000794",
        "book_code": "DM",
        "beginning_page": "0608",
        "total_pages": 7,
        "instrument_date": "2016-05-04 05:00:00",
        "returned_date": "2016-05-12 05:00:00",
        "released_date": "2016-10-11 05:00:00",
        "indexed_date": "2016-05-11 16:45:00",
        "modified_date": "2016-05-12 04:29:07",
        "fees_in_cents": 2500,
        "fee_adjustments_in_cents": 0,
        "document_stamp_fees_in_cents": 0,
        "mortgage_amount_in_cents": 0,
        "free_to_view": false,
        "cost_to_view": 0.4,
        "comments": "Some comment.",
        "parties": [
            {
                "name": "BANCCENTRAL NA",
                "type": "Grantee",
                "address1": "P O BOX 667",
                "address2": "",
                "city": "ALVA",
                "state": "OK",
                "postal": "73717"
            }
        ],
        "legal_descriptions": [
            {
                "section": 11,
                "township": "27",
                "range": "12",
                "block": "",
                "lot": 0,
                "acres": 0,
                "legal": "S11 T27 R12 SW",
                "location": "SW"
            }
        ],
        "images": [
            {
                "number": 1934149,
                "book": "000794",
                "page": "0608",
                "free_to_print": false,
                "print_address": "\/api\/v1\/images?county=Alfalfa&number=1934149&action=print",
                "view_address": "\/api\/v1\/images?county=Alfalfa&number=1934149&action=view"
            }
        ]
    }
]
```

--------------------------------

### GET /api/v1/images

Source: https://okcountyrecords.com/api/v1/documentation/images

Returns the raw PDF contents of an image in either official or watermarked format. Images can be downloaded for $1.00 per page (printing) or viewed for $0.40 per instrument (viewing).

```APIDOC
## GET /api/v1/images

### Description
Returns the raw PDF contents of an image in either official or watermarked format. Images can be downloaded for $1.00 per page (printing) or viewed for $0.40 per instrument (viewing).

### Method
GET

### Endpoint
`https://okcountyrecords.com/api/v1/images`

### Parameters
#### Query Parameters
- **county** (string) - Required - A county name.
- **number** (string) - Required - An image number.
- **action** (string) - Required - Can be "view" or "print".

### Request Example
`https://okcountyrecords.com/api/v1/images?county=Adair&number=352795&action=view`

### Response
#### Success Response (200)
- **Content-Type** (application/pdf) - The raw, binary data of a PDF file.

#### Response Example
```pdf
%PDF-1.4
...
```
```

--------------------------------

### API Error Response Example

Source: https://okcountyrecords.com/api/v1/documentation/error-handling

This is an example of a JSON response when an error occurs during an API request. It contains a single 'error' property detailing the problem. The exact response may vary depending on the nature of the error.

```json
{
  "error": "No API key entered in the password of the authentication of this request."
}
```

--------------------------------

### Authenticate API Requests with Basic Auth (cURL)

Source: https://okcountyrecords.com/api/v1/documentation/authentication

Demonstrates how to authenticate API requests using Basic Authentication with your API key. This method requires your API key to be placed in the username field when making requests to the API. The example uses cURL to show the command structure.

```shell
curl -u **<your key>**: "https://okcountyrecords.com/api/v1/counties"
```

--------------------------------

### GET /api/v1/counties

Source: https://okcountyrecords.com/api/v1/documentation/counties

Retrieves a list of counties served by the Oklahoma County Records system. You can optionally filter the list by county name.

```APIDOC
## GET /api/v1/counties

### Description
Returns a list of one or more of the counties we serve. If the 'name' parameter is not specified, a full list of all counties will be returned.

### Method
GET

### Endpoint
`https://okcountyrecords.com/api/v1/counties`

### Parameters
#### Query Parameters
- **name** (string) - Optional - A county name. If specified, only the matching county will be returned.

### Request Example
`https://okcountyrecords.com/api/v1/counties?name=Beckham`

### Response
#### Success Response (200)
- **code** (integer) - Internal code for the county.
- **name** (string) - The name of the county.
- **official** (string) - The official contact person for the county clerk.
- **address1** (string) - The primary street address of the county courthouse.
- **address2** (string) - Additional address information, such as a P.O. Box.
- **city** (string) - The city where the county courthouse is located.
- **state** (string) - The state abbreviation (e.g., 'OK').
- **postal** (string) - The postal code for the county.
- **phone** (string) - The main phone number for the county clerk's office.
- **email** (string) - The email address for the county clerk's office.
- **hours** (string) - The operating hours for the county clerk's office.
- **website** (string) - The official website URL for the county.
- **data_beginning_date** (string) - The earliest date for which data is available in YYYY-MM-DD format.
- **image_beginning_date** (string) - The earliest date for which images are available in YYYY-MM-DD format.
- **searching_enabled** (integer) - Indicates if searching is enabled for this county (1 for enabled, 0 for disabled).
- **images_enabled** (integer) - Indicates if images are enabled for this county (1 for enabled, 0 for disabled).
- **copies_enabled** (integer) - Indicates if copies are enabled for this county (1 for enabled, 0 for disabled).
- **tokens_per_page** (integer) - The number of tokens allowed per page for searches.
- **number_of_instruments** (integer) - The total number of instruments recorded in the county.
- **number_of_images** (integer) - The total number of images available for the county.
- **comments_enabled** (integer) - Indicates if comments are enabled for this county (1 for enabled, 0 for disabled).

#### Response Example
```json
[
    {
        "code": 5,
        "name": "Beckham",
        "official": "Leasa Hartman",
        "address1": "Beckham County Courthouse",
        "address2": "P.O. Box 428",
        "city": "Sayre",
        "state": "OK",
        "postal": "73662",
        "phone": "(580) 928-3383",
        "email": "bkcoclerk@cableone.net",
        "hours": "8:00am - 4:00pm",
        "website": "http:\/\/beckham.okcounties.org",
        "data_beginning_date": "1990-05-22",
        "image_beginning_date": "1990-05-30",
        "searching_enabled": 1,
        "images_enabled": 1,
        "copies_enabled": 1,
        "tokens_per_page": 1,
        "number_of_instruments": 238642,
        "number_of_images": 1162628,
        "comments_enabled": 0
    }
]
```
```

--------------------------------

### GET /api/v1/problem-reports

Source: https://okcountyrecords.com/api/v1/documentation/problem-reports

Retrieves a list of submitted problem reports, both past and current. Supports filtering by resolution status, county, book, page number, and creation/resolution dates.

```APIDOC
## GET /api/v1/problem-reports

### Description
Returns a list of your submitted problem reports, past and current.

### Method
GET

### Endpoint
`https://okcountyrecords.com/api/v1/problem-reports`

### Parameters
#### Query Parameters
- **resolved** (integer) - Optional - Can be 1 or 0. Return only reports that are or are not resolved.
- **county** (string) - Optional - A county name.
- **book** (string) - Optional - A book number.
- **beginning_page** (string) - Optional - The number of the first page of the instrument.
- **created_date_start** (string) - Optional - Only return reports created after this date (YYYY-MM-DD).
- **created_date_end** (string) - Optional - Only return reports created before this date (YYYY-MM-DD).
- **resolved_date_start** (string) - Optional - Only return reports resolved after this date (YYYY-MM-DD).
- **resolved_date_end** (string) - Optional - Only return reports resolved before this date (YYYY-MM-DD).
- **results_per_page** (integer) - Optional - The maximum number of results to include on each page. Default and maximum of 100.
- **result_page** (integer) - Optional - The page number of results to be returned. Default is 1. Can be used to iterate over multiple pages of results.

### Request Example
`https://okcountyrecords.com/api/v1/problem-reports?resolved=1`

### Response
#### Success Response (200)
- **county** (string) - The name of the county.
- **book** (string) - The book number.
- **beginning_page** (string) - The starting page number of the instrument.
- **created_date** (string) - The date and time the report was created.
- **resolved** (boolean) - Indicates if the report has been resolved.
- **resolved_date** (string) - The date and time the report was resolved.
- **resolution** (string) - The method used to resolve the report.
- **detail_url** (string) - A URL to the detailed view of the record.
- **return_email** (string) - An email address for return notifications.
- **return_webhook** (string) - A webhook URL for return notifications.
- **description** (string) - A description of the problem.
- **incorrect_legal_description** (boolean) - Flag for incorrect legal description.
- **incorrect_images** (boolean) - Flag for incorrect images.
- **incorrect_instrument_type** (boolean) - Flag for incorrect instrument type.
- **incorrect_parties** (boolean) - Flag for incorrect parties.

#### Response Example
```json
[
	{
		"county": "Adair",
		"book": "000293",
		"beginning_page": "0737",
		"created_date": "2018-05-01 14:01:20.712932",
		"resolved": true,
		"resolved_date": "2018-05-01 14:01:53.743512",
		"resolution": "manually-fixed",
		"detail_url": "\/detail\/adair\/1996-035627\/2221655",
		"return_email": "john.doe@someservice.com",
		"return_webhook": "http:\/\/mysite.com\/problem-resolved",
		"description": "The grantor's name is misspelled.",
		"incorrect_legal_description": false,
		"incorrect_images": false,
		"incorrect_instrument_type": false,
		"incorrect_parties": true
	}
]
```
```

--------------------------------

### Webhook Request Body Format for Problem Resolution

Source: https://okcountyrecords.com/api/v1/documentation/report-a-problem

This example shows the JSON payload structure for a webhook POST request when a problem has been resolved. The webhook will be sent hourly for 24 hours until a 200 response is received. It includes details about the resolved instrument and the resolution type.

```json
{
	"county": "Adair",
	"book": "000293",
	"beginning_page": "0737",
	"resolution": "manually-fixed"
}
```

--------------------------------

### Get County List API Request

Source: https://okcountyrecords.com/api/v1/documentation/counties

Fetches a list of counties served by the API. This endpoint can optionally filter by county name. It returns an array of county objects, each containing detailed information.

```HTTP
GET https://okcountyrecords.com/api/v1/counties
GET https://okcountyrecords.com/api/v1/counties?name=Beckham
```

--------------------------------

### GET /api/v1/instrument-types

Source: https://okcountyrecords.com/api/v1/documentation/instrument-types

Retrieves the list of instrument types for a specified county. The response may have formatting changes compared to the original data.

```APIDOC
## GET /api/v1/instrument-types

### Description
Returns the list of instrument types for a county. The API modifies the formatting of instrument types by replacing forward slashes with hyphens and adjusting casing. For example, "oil & gas lease" becomes "Oil & Gas Lease", and "ogl" becomes "OGL". It is still possible to search using the original formatting.

### Method
GET

### Endpoint
https://okcountyrecords.com/api/v1/instrument-types

### Parameters
#### Query Parameters
- **county** (string) - Required - The name of the county for which to retrieve instrument types.

### Request Example
```
https://okcountyrecords.com/api/v1/instrument-types?county=Adair
```

### Response
#### Success Response (200)
- **name** (string) - The name of the instrument type.
- **alternate_name** (string) - An alternate name or abbreviation for the instrument type.
- **number_of_instruments** (integer) - The count of instruments associated with this type.

#### Response Example
```json
[
    {
        "name": "Mortgage",
        "alternate_name": "MTG",
        "number_of_instruments": 3857
    }
]
```
```

--------------------------------

### Get List of Books by County - API Request

Source: https://okcountyrecords.com/api/v1/documentation/books

This snippet demonstrates how to request a list of books for a given county using the API. It requires the 'county' parameter. The response is a JSON array of book objects.

```HTTP
https://okcountyrecords.com/api/v1/books?county=Adair
```

--------------------------------

### Get Instrument Types by County (REST API)

Source: https://okcountyrecords.com/api/v1/documentation/instrument-types

Retrieves a list of instrument types available for a specified county. Note that forward slashes in instrument types are replaced with hyphens, and casing is adjusted for consistency. This endpoint is crucial for filtering and understanding available record types within a county.

```HTTP
GET https://okcountyrecords.com/api/v1/instrument-types?county=Adair
```

```JSON
[
    {
        "name": "Mortgage",
        "alternate_name": "MTG",
        "number_of_instruments": 3857
    }
]
```

--------------------------------

### API Search Resource

Source: https://okcountyrecords.com/api/v1/documentation/search

Runs a search for land records and returns the results. You can download up to 150 search results per day for free, and then pay $0.01 for each subsequent result. All dates should be provided in "yyyy-mm-dd" format.

```APIDOC
## GET /api/v1/search

### Description
Searches for land records based on various criteria and returns a list of matching instruments. Supports filtering by county, text, instrument type, dates, and legal descriptions. Offers pagination and sorting options.

### Method
GET

### Endpoint
`https://okcountyrecords.com/api/v1/search`

### Parameters
#### Query Parameters
- **county** (string) - Required if not searching by **text**. A county name.
- **text** (string) - A piece of text appearing anywhere on an instrument, including its parties and legal descriptions. If this parameter is provided, all other search parameters except **county** will be ignored.
- **type** (string) - The name of one or more instrument types, separated with a vertical pipe ("|"). e.g. "Mortgage", or "Mortgage|MTG".
- **type-name-only** (string) - Provide "1" to indicate that **type** should not match on **alternate_name**.
- **record_type** (string) - "I" for instrument or "L" for lien. Used with **series** and **number**.
- **series** (string) - A series number. e.g. "2010".
- **number** (string) - An instrument number. e.g. "84238".
- **book** (string) - A book number. e.g. "794".
- **page** (string) - A page number. e.g. "608". Can be any of the pages of an instrument.
- **party_name** (string) - The name or part of the name of a party. e.g. "Smith".
- **party_type** (string) - The type of the party specified with the **party_name** parameter. Can be "Grantor", "Grantee", "Lienholder", or "Issued Against".
- **legal_description** (string) - A legal description or part of a legal description. e.g. "S11 T27 R12 SW".
- **section** (string) - The section of a legal description. e.g. "15".
- **township** (string) - The township of a legal description. e.g. "11E".
- **range** (string) - The range of a legal description. e.g. "6W".
- **addition** (string) - The addition of a legal description. e.g. "Allen Addition".
- **block** (string) - The block of a legal description. e.g. "4".
- **lot** (string) - The lot of a legal description. e.g. "10".
- **quarter** (string) - The quarter of a legal description. e.g. "NW NE".
- **indexed_date_start** (string) - Only instruments that were indexed on or after this date will be returned. The indexed date is the date the instrument was recorded by the county clerk's office. Format: yyyy-mm-dd.
- **indexed_date_end** (string) - Only instruments that were indexed on or before this date will be returned. The indexed date is the date the instrument was recorded by the county clerk's office. Format: yyyy-mm-dd.
- **instrument_date_start** (string) - Only instruments with an instrument date on or after this date will be returned. Format: yyyy-mm-dd.
- **instrument_date_end** (string) - Only instruments with an instrument date on or before this date will be returned. Format: yyyy-mm-dd.
- **modified_date_start** (string) - Only instruments that have been modified on or after this date will be returned. Format: yyyy-mm-dd.
- **modified_date_end** (string) - Only instruments that have been modified on or before this date will be returned. Format: yyyy-mm-dd.
- **indexed_or_modified_date_start** (string) - Only instruments that have been indexed or modified on or after this date will be returned. End date is required. Format: yyyy-mm-dd.
- **indexed_or_modified_date_end** (string) - Only instruments that have been indexed or modified on or before this date will be returned. Start date is required. Format: yyyy-mm-dd.
- **results_per_page** (integer) - The maximum number of results to include on each page. Default and maximum of 15.
- **result_page** (integer) - The page number of results to be returned. Default is 1. Can be used to iterate over multiple pages of results.
- **order_by** (string) - The field to order the results by. Can be "series", "book", or "indexed_date". Default is "indexed_date".
- **order_direction** (string) - The direction to order the results by. Can be "asc" or "desc". Default is "desc".

### Request Example
```json
{
  "county": "Oklahoma",
  "indexed_date_start": "2023-01-01",
  "results_per_page": 15
}
```

### Response
#### Success Response (200)
- **results** (array) - An array of instrument objects matching the search criteria.
- **Each instrument object may contain fields like:**
  - `series` (string)
  - `book` (string)
  - `page` (string)
  - `instrument_type` (string)
  - `instrument_date` (string)
  - `indexed_date` (string)
  - `parties` (array)
  - `legal_description` (string)
  - `document_url` (string)

#### Response Example
```json
{
  "results": [
    {
      "series": "2023",
      "book": "1234",
      "page": "567",
      "instrument_type": "Warranty Deed",
      "instrument_date": "2023-01-15",
      "indexed_date": "2023-01-16",
      "parties": [
        {"name": "John Doe", "type": "Grantor"},
        {"name": "Jane Smith", "type": "Grantee"}
      ],
      "legal_description": "LOT 5 BLOCK 2",
      "document_url": "https://okcountyrecords.com/api/v1/documents/12345"
    }
  ]
}
```

### Paging Headers
These HTTP headers will be sent with each response to help your program iterate over multiple pages of results.
- **API-Total-Result-Count** (integer) - The total number of results that your query returned.
- **API-Total-Image-Count** (integer) - The total number of images that your query returned.
- **API-Result-Page-Count** (integer) - The total number of pages of results that your query returned.
- **API-Results-Per-Page** (integer) - The maximum number of results included on each page.
- **API-Result-Page** (integer) - The page number of results for this request.
- **API-Next-Page-Address** (string) - The address for the next page when available.
- **API-Previous-Page-Address** (string) - The address for the previous page when available.
```

--------------------------------

### API Offices Resource

Source: https://okcountyrecords.com/api/v1/documentation/offices

Returns a list of offices for counties served by the API that have multiple offices. If no parameters are specified, a full list of offices will be returned.

```APIDOC
## GET /api/v1/offices

### Description
Returns a list of offices for counties served by the API that have multiple offices. If no parameters are specified, a full list of offices will be returned.

### Method
GET

### Endpoint
https://okcountyrecords.com/api/v1/offices

### Parameters
#### Query Parameters
- **county** (string) - Optional - A county name.
- **code** (string) - Optional - An office code.

### Request Example
```json
https://okcountyrecords.com/api/v1/offices?county=Arkansas
```

### Response
#### Success Response (200)
- **code** (integer) - The office code.
- **county** (string) - The name of the county.
- **name** (string) - The name of the office.

#### Response Example
```json
[
    {
        "code": 1,
        "county": "Arkansas",
        "name": "Southern District (DeWitt)"
    },
    {
        "code": 2,
        "county": "Arkansas",
        "name": "Nothern District (Stuttgart)"
    }
]
```
```

--------------------------------

### List County Offices API Request

Source: https://okcountyrecords.com/api/v1/documentation/offices

Fetches a list of county offices. If no parameters are provided, it returns all offices. Currently, only Arkansas County, AR, has multiple offices.

```HTTP
https://okcountyrecords.com/api/v1/offices?county=Arkansas
```

--------------------------------

### List Books by County

Source: https://okcountyrecords.com/api/v1/documentation/books

Retrieves a list of books available for a specified county. This endpoint is useful for browsing available records within a county.

```APIDOC
## GET /api/v1/books

### Description
Returns the list of books for a specified county.

### Method
GET

### Endpoint
`/api/v1/books`

### Parameters
#### Query Parameters
- **county** (string) - Required - The name of the county for which to retrieve books.

### Request Example
```
https://okcountyrecords.com/api/v1/books?county=Adair
```

### Response
#### Success Response (200)
- **number** (string) - The book number.
- **number_of_pages** (integer) - The total number of pages in the book.
- **search_address** (string) - A URL to search for instruments within this book.

#### Response Example
```json
[
    {
        "number": "000139",
        "number_of_pages": 930,
        "search_address": "\/api\/v1\/instruments?county=Adair&book=000139"
    }
]
```
```

--------------------------------

### Report a Problem Resource

Source: https://okcountyrecords.com/api/v1/documentation/report-a-problem

Submits a problem report for a given instrument. The API checks these reports regularly and works with the county to resolve scanning or indexing issues.

```APIDOC
## POST /api/v1/report-a-problem

### Description
Submits a problem report for a given instrument and optionally notifies the user when the problem is resolved via email or webhook. The API checks these reports regularly and works with the county to resolve issues with scanning or indexing.

### Method
POST

### Endpoint
`https://okcountyrecords.com/api/v1/report-a-problem`

### Parameters
#### Query Parameters
- **county** (string) - Required - A county name.
- **book** (string) - Required - A book number.
- **beginning_page** (string) - Required - The number of the first page of the problem instrument.
- **description** (string) - Optional - A description of the problem found.
- **incorrect_legal_description** (integer) - Optional - Providing 1 indicates a problem with the legal description. Must indicate at least one problem.
- **incorrect_images** (integer) - Optional - Providing 1 indicates a problem with the images.
- **incorrect_instrument_type** (integer) - Optional - Providing 1 indicates a problem with the instrument type.
- **incorrect_parties** (integer) - Optional - Providing 1 indicates a problem with the parties.
- **return_email** (string) - Optional - If specified, this address will receive an email when the problem is resolved.
- **return_webhook** (string) - Optional - If specified, this URL will be hit when the problem is resolved.

### Request Example
```json
{
  "request_url": "https://okcountyrecords.com/api/v1/report-a-problem?county=Adair&book=293&beginning_page=737&incorrect_images=1&return_email=john.doe@someservice.com&return_webhook=http://mysite.com/problem-resolution"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the report was submitted successfully.

#### Response Example
```json
{
  "success": true
}
```

## Webhooks
Once the problem has been resolved, the provided URL will receive a POST request once every hour for 24 hours until a 200 response code is received. The POST body will be in the following format:

```json
{
  "county": "Adair",
  "book": "000293",
  "beginning_page": "0737",
  "resolution": "manually-fixed"
}
```

Possible resolutions include:
- `automatic-repull`
- `manually-fixed`
- `talk-to-clerk`
- `kellpro-notified-clerk`
- `no-issue`
- `clerk-files-that-way`
- `pdf-viewer`
- `external-response`
- `no-response`
```

--------------------------------

### Search Records

Source: https://okcountyrecords.com/api/v1/documentation/search

This endpoint allows you to search for county records based on various criteria such as county, book, and page number.

```APIDOC
## GET /api/v1/search

### Description
Searches for county records based on provided parameters.

### Method
GET

### Endpoint
`/api/v1/search`

### Parameters
#### Query Parameters
- **county** (string) - Required - The name of the county to search within.
- **book** (string) - Required - The book number where the record is located.
- **page** (string) - Required - The page number of the record within the book.

### Request Example
```
https://okcountyrecords.com/api/v1/search?county=Alfalfa&book=794&page=608
```

### Response
#### Success Response (200)
Returns an array of record objects matching the search criteria.

**Response Field Notes:**
- **record_type** (string) - Will either be "I" for instrument or "L" for lien.
- **modified_date** (string) - The last time the instrument was modified. Available from June 3rd, 2015 forward.
- **free_to_view** (boolean) - Indicates whether you can view all the images in this instrument for free.
- **cost_to_view** (number) - How much it will cost to view all the images in this instrument. Will be 0.4 for indexed instruments, 0.1 for non-indexed images, or 0 if you've previously paid.
- **free_to_print** (boolean) - Indicates whether you can print this image again for free.
- **comments** (string) - Comments from the county clerk's office about the instrument.
- **book_code** (string) - A code distinguishing different types of books in some counties.
- **county** (string) - The name of the county.
- **office_code** (string) - The office code.
- **type** (string) - The type of record (e.g., "Mortgage").
- **series** (string) - The series number.
- **number** (string) - The record number.
- **book** (string) - The book number.
- **beginning_page** (string) - The starting page number.
- **total_pages** (integer) - The total number of pages for the record.
- **instrument_date** (string) - The date the instrument was created.
- **returned_date** (string) - The date the record was returned.
- **released_date** (string) - The date the record was released.
- **indexed_date** (string) - The date the record was indexed.
- **fees_in_cents** (integer) - Fees associated with the record in cents.
- **fee_adjustments_in_cents** (integer) - Fee adjustments in cents.
- **document_stamp_fees_in_cents** (integer) - Document stamp fees in cents.
- **mortgage_amount_in_cents** (integer) - Mortgage amount in cents.
- **parties** (array) - An array of party objects associated with the record.
  - **name** (string) - The name of the party.
  - **type** (string) - The type of party (e.g., "Grantee").
  - **address1** (string) - The first line of the party's address.
  - **address2** (string) - The second line of the party's address.
  - **city** (string) - The city of the party's address.
  - **state** (string) - The state of the party's address.
  - **postal** (string) - The postal code of the party's address.
- **legal_descriptions** (array) - An array of legal description objects.
  - **section** (integer) - The section number.
  - **township** (string) - The township number.
  - **range** (string) - The range number.
  - **block** (string) - The block number.
  - **lot** (integer) - The lot number.
  - **acres** (number) - The number of acres.
  - **legal** (string) - The legal description string.
  - **location** (string) - The location identifier.
- **images** (array) - An array of image objects.
  - **number** (integer) - The image number.
  - **book** (string) - The book number associated with the image.
  - **page** (string) - The page number of the image.
  - **free_to_print** (boolean) - Indicates if the image can be printed for free.
  - **print_address** (string) - The URL to print the image.
  - **view_address** (string) - The URL to view the image.

#### Response Example
```json
[
    {
        "county": "Alfalfa",
        "office_code": null,
        "type": "Mortgage",
        "record_type": "I",
        "series": "2016",
        "number": "084238",
        "book": "000794",
        "book_code": "DM",
        "beginning_page": "0608",
        "total_pages": 7,
        "instrument_date": "2016-05-04 05:00:00",
        "returned_date": "2016-05-12 05:00:00",
        "released_date": "2016-10-11 05:00:00",
        "indexed_date": "2016-05-11 16:45:00",
        "modified_date": "2016-05-12 04:29:07",
        "fees_in_cents": 2500,
        "fee_adjustments_in_cents": 0,
        "document_stamp_fees_in_cents": 0,
        "mortgage_amount_in_cents": 0,
        "free_to_view": false,
        "cost_to_view": 0.4,
        "comments": "Some comment.",
        "parties": [
            {
                "name": "BANCCENTRAL NA",
                "type": "Grantee",
                "address1": "P O BOX 667",
                "address2": "",
                "city": "ALVA",
                "state": "OK",
                "postal": "73717"
            }
        ],
        "legal_descriptions": [
            {
                "section": 11,
                "township": "27",
                "range": "12",
                "block": "",
                "lot": 0,
                "acres": 0,
                "legal": "S11 T27 R12 SW",
                "location": "SW"
            }
        ],
        "images": [
            {
                "number": 1934149,
                "book": "000794",
                "page": "0608",
                "free_to_print": false,
                "print_address": "\/api\/v1\/images?county=Alfalfa&number=1934149&action=print",
                "view_address": "\/api\/v1\/images?county=Alfalfa&number=1934149&action=view"
            }
        ]
    }
]
```
```
Tokens:
Raw